review 1.4.0 → 1.5.0

data/lib/review/book/compilable.rb

@@ -59,7 +59,11 @@ module ReVIEW
       end
 
       def volume
-        @volume ||= Volume.count_file(path())
+        if !@volume
+          @volume = Volume.count_file(path())
+          @volume.page_per_kbyte = @book.page_metric.page_per_kbyte
+        end
+        @volume
       end
 
       def open(&block)

data/lib/review/book/index.rb

@@ -12,6 +12,7 @@
 require 'review/extentions'
 require 'review/exception'
 require 'review/book/image_finder'
+require 'review/i18n'
 
 module ReVIEW
   module Book
@@ -56,11 +57,21 @@ module ReVIEW
       def [](id)
         @index.fetch(id)
       rescue
+        if @index.keys.map{|i| i.split(/\|/) }.flatten. # unfold all ids
+            reduce(Hash.new(0)){|h, i| h[i] += 1; h}.  # number of occurrences
+            select{|k, v| k == id && v > 1 }.present? # detect duplicated
+          raise KeyError, "key '#{id}' is ambiguous for #{self.class}"
+        end
+        @items.each do |i|
+          if i.id.split(/\|/).include?(id)
+            return i
+          end
+        end
         raise KeyError, "not found key '#{id}' for #{self.class}"
       end
 
       def number(id)
-        @index.fetch(id).number.to_s
+        self[id].number.to_s
       end
 
       def each(&block)
@@ -92,7 +103,7 @@ module ReVIEW
       end
 
       def display_string(id)
-        "#{number(id)}「#{title(id)}」"
+        "#{number(id)}#{I18n.t("chapter_quote", title(id))}"
       end
     end
 
@@ -131,16 +142,35 @@ module ReVIEW
 
 
     class ImageIndex < Index
+      def self.parse(src, *args)
+        items = []
+        seq = 1
+        src.grep(%r<^//#{item_type()}>) do |line|
+          # ex. ["//image", "id", "", "caption"]
+          elements = line.split(/\[(.*?)\]/)
+          if elements[1].present?
+            items.push item_class().new(elements[1], seq, elements[3])
+            seq += 1
+            if elements[1] == ""
+              warn "warning: no ID of #{item_type()} in #{line}"
+            end
+          end
+        end
+        new(items, *args)
+      end
+
       class Item
 
-        def initialize(id, number)
+        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?
@@ -150,7 +180,6 @@ module ReVIEW
         def path
           @path ||= @index.find_path(id)
         end
-
       end
 
       def ImageIndex.item_type
@@ -175,7 +204,6 @@ module ReVIEW
       def find_path(id)
         @image_finder.find_path(id)
       end
-
     end
 
     class IconIndex < ImageIndex
@@ -251,11 +279,6 @@ module ReVIEW
 
     class NumberlessImageIndex < ImageIndex
       class Item < ImageIndex::Item
-        def initialize(id, number)
-          @id = id
-          @number = ""
-          @path = nil
-        end
       end
 
       def NumberlessImageIndex.item_type
@@ -269,11 +292,6 @@ module ReVIEW
 
     class IndepImageIndex < ImageIndex
       class Item < ImageIndex::Item
-        def initialize(id, number)
-          @id = id
-          @number = ""
-          @path = nil
-        end
       end
 
       def IndepImageIndex.item_type
@@ -309,7 +327,7 @@ module ReVIEW
               inside_column = false
               next
             end
-            if indexs.present? and indexs[-1] <= index
+            if indexs.blank? || index <= indexs[-1]
               inside_column = false
             end
             if inside_column
@@ -344,7 +362,20 @@ module ReVIEW
       end
 
       def number(id)
-        return ([@chap.number] + @index.fetch(id).number).join(".")
+        n = @chap.number
+        if @chap.on_APPENDIX? && @chap.number > 0 && @chap.number < 28
+          type = @chap.book.config["appendix_format"].blank? ? "arabic" : @chap.book.config["appendix_format"].downcase.strip
+          n = case type
+              when "roman"
+                ROMAN[@chap.number]
+              when "alphabet", "alpha"
+                ALPHA[@chap.number]
+              else
+                # nil, "arabic", etc...
+                "#{@chap.number}"
+              end
+        end
+        return ([n] + self[id].number).join(".")
       end
     end
 

data/lib/review/book/page_metric.rb

@@ -15,24 +15,33 @@ module ReVIEW
 
       MetricData = Struct.new(:n_lines, :n_columns)
 
-      def PageMetric.a5
-        new(46, 80, 30, 74, 1)
-      end
-
-      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)
         @page_per_kbyte = page_per_kbyte
       end
 
+      A5 = PageMetric.new(46, 80, 30, 74, 1)
+      B5 = PageMetric.new(46, 80, 30, 74, 2)
+
+      # backward compatible
+      def PageMetric.a5
+        ReVIEW::Book::PageMetric::A5
+      end
+
+      # backward compatible
+      def PageMetric.b5
+        ReVIEW::Book::PageMetric::B5
+      end
+
       attr_reader :list
       attr_reader :text
       attr_reader :page_per_kbyte
 
+      def ==(other)
+        self.list == other.list && self.text == other.text && self.page_per_kbyte == other.page_per_kbyte
+      end
+
     end
   end
 end

data/lib/review/book/part.rb

@@ -2,7 +2,7 @@
 # $Id: book.rb 4315 2009-09-02 04:15:24Z kmuto $
 #
 # Copyright (c) 2002-2008 Minero Aoki
-#               2009 Minero Aoki, Kenshi Muto
+#               2009-2014 Minero Aoki, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -32,13 +32,23 @@ module ReVIEW
       end
 
       def volume
-        Volume.sum(@chapters.map {|chap| chap.volume })
+        vol = Volume.sum(@chapters.map {|chap| chap.volume })
+        vol.page_per_kbyte = @book.page_metric.page_per_kbyte
+        vol
       end
 
       def file?
         (name.present? and path =~ /\.re\z/) ? true : false
       end
 
+      def format_number(heading = true)
+        if heading
+          "#{I18n.t("part", @number)}"
+        else
+          "#{@number}"
+        end
+      end
+
     end
   end
 end

data/lib/review/book/volume.rb

@@ -36,19 +36,20 @@ module ReVIEW
         @bytes = bytes
         @chars = chars
         @lines = lines
-        @book  = ReVIEW::Book::Base.load_default
+        @page_per_kbyte = nil
       end
 
       attr_reader :bytes
       attr_reader :chars
       attr_accessor :lines
+      attr_accessor :page_per_kbyte
 
       def kbytes
         (@bytes.to_f / 1024).ceil
       end
 
       def page
-        (kbytes.to_f/@book.page_metric.page_per_kbyte).ceil
+        (kbytes.to_f/@page_per_kbyte).ceil
       end
 
       def to_s

data/lib/review/builder.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 #
-# Copyright (c) 2002-2009 Minero Aoki
+# Copyright (c) 2002-2014 Minero Aoki, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -11,6 +11,7 @@ require 'review/book/index'
 require 'review/exception'
 require 'review/textutils'
 require 'review/compiler'
+require 'review/sec_counter'
 require 'stringio'
 require 'cgi'
 
@@ -51,6 +52,7 @@ module ReVIEW
     end
 
     def builder_init_file
+      @sec_counter = SecCounter.new(5, @chapter)
     end
     private :builder_init_file
 
@@ -76,22 +78,30 @@ module ReVIEW
       self.class.to_s.gsub(/ReVIEW::/, '').gsub(/Builder/, '').downcase
     end
 
-    def list(lines, id, caption)
+    def headline_prefix(level)
+      @sec_counter.inc(level)
+      anchor = @sec_counter.anchor(level)
+      prefix = @sec_counter.prefix(level, @book.config["secnolevel"])
+      [prefix, anchor]
+    end
+    private :headline_prefix
+
+    def list(lines, id, caption, lang = nil)
       begin
-        list_header id, caption
+        list_header id, caption, lang
       rescue KeyError
         error "no such list: #{id}"
       end
-      list_body id, lines
+      list_body id, lines, lang
     end
 
-    def listnum(lines, id, caption)
+    def listnum(lines, id, caption, lang = nil)
       begin
-        list_header id, caption
+        list_header id, caption, lang
       rescue KeyError
         error "no such list: #{id}"
       end
-      listnum_body lines
+      listnum_body lines, lang
     end
 
     def source(lines, caption)
@@ -176,21 +186,21 @@ module ReVIEW
     end
 
     def inline_chapref(id)
-      compile_inline @chapter.env.chapter_index.display_string(id)
+      compile_inline @book.chapter_index.display_string(id)
     rescue KeyError
       error "unknown chapter: #{id}"
       nofunc_text("[UnknownChapter:#{id}]")
     end
 
     def inline_chap(id)
-      @chapter.env.chapter_index.number(id)
+      @book.chapter_index.number(id)
     rescue KeyError
       error "unknown chapter: #{id}"
       nofunc_text("[UnknownChapter:#{id}]")
     end
 
     def inline_title(id)
-      compile_inline @chapter.env.chapter_index.title(id)
+      compile_inline @book.chapter_index.title(id)
     rescue KeyError
       error "unknown chapter: #{id}"
       nofunc_text("[UnknownChapter:#{id}]")
@@ -210,6 +220,16 @@ module ReVIEW
       nofunc_text("[UnknownImage:#{id}]")
     end
 
+    def inline_imgref(id)
+      img = inline_img(id)
+
+      if @chapter.image(id).caption
+        "#{img}#{I18n.t('image_quote', @chapter.image(id).caption)}"
+      else
+        img
+      end
+    end
+
     def inline_table(id)
       "#{I18n.t("table")}#{@chapter.table(id).number}"
     rescue KeyError

data/lib/review/compiler.rb

@@ -12,6 +12,7 @@ require 'review/extentions'
 require 'review/preprocessor'
 require 'review/exception'
 require 'lineinput'
+require 'strscan'
 
 module ReVIEW
 
@@ -130,15 +131,15 @@ module ReVIEW
 
     defblock :read, 0
     defblock :lead, 0
-    defblock :list, 2
-    defblock :emlist, 0..1
+    defblock :list, 2..3
+    defblock :emlist, 0..2
     defblock :cmd, 0..1
     defblock :table, 0..2
     defblock :quote, 0
     defblock :image, 2..3, true
     defblock :source, 0..1
-    defblock :listnum, 2
-    defblock :emlistnum, 0..1
+    defblock :listnum, 2..3
+    defblock :emlistnum, 0..2
     defblock :bibpaper, 2..3, true
     defblock :doorquote, 1
     defblock :talk, 0
@@ -172,6 +173,7 @@ module ReVIEW
     definline :chap
     definline :title
     definline :img
+    definline :imgref
     definline :icon
     definline :list
     definline :table

data/lib/review/configure.rb

@@ -5,7 +5,7 @@ module ReVIEW
       Configure[
         # These parameters can be overridden by YAML file.
         "bookname"=> "example", # it defines epub file name also
-        "booktitle" => "Re:VIEW EPUBサンプル",
+        "booktitle" => "Re:VIEW Sample Book",
         "title" => nil,
         "aut" => nil, # author
         "prt" => nil, # printer(publisher)
@@ -27,13 +27,13 @@ module ReVIEW
         "params" => "", # specify review2html parameters
         "toclevel" => 3, # level of toc
         "secnolevel" => 2, # level of section #
-        "posthook" => nil, # command path of post hook
         "epubversion" => 2,
         "titlepage" => true, # Use title page
-        "toc" => true, # Use table of contents
+        "toc" => nil, # Use table of contents in body
         "colophon" => nil, # Use colophon
         "debug" => nil, # debug flag
         "catalogfile" => 'catalog.yml',
+        "language" => 'ja', # XXX default language should be JA??
 
         "chapter_file" => 'CHAPS',
         "part_file"    => 'PART',

data/lib/review/epubmaker.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 #
-# Copyright (c) 2010-2014 Kenshi Muto and Masayoshi Takahashi
+# Copyright (c) 2010-2015 Kenshi Muto and Masayoshi Takahashi
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -36,6 +36,7 @@ module ReVIEW
 
   def produce(yamlfile, bookname=nil)
     load_yaml(yamlfile)
+    I18n.setup(@params["language"])
     bookname = @params["bookname"] if bookname.nil?
     booktmpname = "#{bookname}-epub"
 
@@ -48,26 +49,26 @@ module ReVIEW
     begin
       log("Created first temporary directory as #{basetmpdir}.")
 
-      log("Call hook_beforeprocess. (#{@params["hook_beforeprocess"]})")
-      call_hook(@params["hook_beforeprocess"], basetmpdir)
+      log("Call hook_beforeprocess. (#{@params["epubmaker"]["hook_beforeprocess"]})")
+      call_hook(@params["epubmaker"]["hook_beforeprocess"], basetmpdir)
 
       copy_stylesheet(basetmpdir)
 
       copy_frontmatter(basetmpdir)
-      log("Call hook_afterfrontmatter. (#{@params["hook_afterfrontmatter"]})")
-      call_hook(@params["hook_afterfrontmatter"], basetmpdir)
+      log("Call hook_afterfrontmatter. (#{@params["epubmaker"]["hook_afterfrontmatter"]})")
+      call_hook(@params["epubmaker"]["hook_afterfrontmatter"], basetmpdir)
 
       build_body(basetmpdir, yamlfile)
-      log("Call hook_afterbody. (#{@params["hook_afterbody"]})")
-      call_hook(@params["hook_afterbody"], basetmpdir)
+      log("Call hook_afterbody. (#{@params["epubmaker"]["hook_afterbody"]})")
+      call_hook(@params["epubmaker"]["hook_afterbody"], basetmpdir)
 
       copy_backmatter(basetmpdir)
-      log("Call hook_afterbackmatter. (#{@params["hook_afterbackmatter"]})")
-      call_hook(@params["hook_afterbackmatter"], basetmpdir)
+      log("Call hook_afterbackmatter. (#{@params["epubmaker"]["hook_afterbackmatter"]})")
+      call_hook(@params["epubmaker"]["hook_afterbackmatter"], basetmpdir)
 
       push_contents(basetmpdir)
 
-      if !@params["verify_target_images"].nil?
+      if !@params["epubmaker"]["verify_target_images"].nil?
         verify_target_images(basetmpdir)
         copy_images(@params["imagedir"], basetmpdir)
       else
@@ -78,8 +79,8 @@ module ReVIEW
       copy_resources("adv", "#{basetmpdir}/images")
       copy_resources(@params["fontdir"], "#{basetmpdir}/fonts", @params["font_ext"])
 
-      log("Call hook_aftercopyimage. (#{@params["hook_aftercopyimage"]})")
-      call_hook(@params["hook_aftercopyimage"], basetmpdir)
+      log("Call hook_aftercopyimage. (#{@params["epubmaker"]["hook_aftercopyimage"]})")
+      call_hook(@params["epubmaker"]["hook_aftercopyimage"], basetmpdir)
 
       @epub.import_imageinfo("#{basetmpdir}/images", basetmpdir)
       @epub.import_imageinfo("#{basetmpdir}/fonts", basetmpdir, @params["font_ext"])
@@ -110,7 +111,7 @@ module ReVIEW
 
         File.open("#{basetmpdir}/#{content.file}") do |f|
           Document.new(File.new(f)).each_element("//img") do |e|
-            @params["force_include_images"].push(e.attributes["src"])
+            @params["epubmaker"]["force_include_images"].push(e.attributes["src"])
             if e.attributes["src"] =~ /svg\Z/i
               content.properties.push("svg")
             end
@@ -120,21 +121,21 @@ module ReVIEW
         File.open("#{basetmpdir}/#{content.file}") do |f|
           f.each_line do |l|
             l.scan(/url\((.+?)\)/) do |m|
-              @params["force_include_images"].push($1.strip)
+              @params["epubmaker"]["force_include_images"].push($1.strip)
             end
           end
         end
       end
     end
-    @params["force_include_images"] = @params["force_include_images"].sort.uniq
+    @params["epubmaker"]["force_include_images"] = @params["epubmaker"]["force_include_images"].sort.uniq
   end
 
   def copy_images(resdir, destdir, allow_exts=nil)
     return nil unless File.exist?(resdir)
     allow_exts = @params["image_ext"] if allow_exts.nil?
     FileUtils.mkdir_p(destdir) unless FileTest.directory?(destdir)
-    if !@params["verify_target_images"].nil?
-      @params["force_include_images"].each do |file|
+    if !@params["epubmaker"]["verify_target_images"].nil?
+      @params["epubmaker"]["force_include_images"].each do |file|
         unless File.exist?(file)
           warn "#{file} is not found, skip." if file !~ /\Ahttp[s]?:/
           next
@@ -164,7 +165,7 @@ module ReVIEW
           recursive_copy_files("#{resdir}/#{fname}", "#{destdir}/#{fname}", allow_exts)
         else
           if fname =~ /\.(#{allow_exts.join("|")})\Z/i
-            Dir.mkdir(destdir) unless File.exist?(destdir)
+            FileUtils.mkdir_p(destdir) unless File.exist?(destdir)
             log("Copy #{resdir}/#{fname} to the temporary directory.")
             FileUtils.cp("#{resdir}/#{fname}", destdir)
           end
@@ -185,7 +186,9 @@ module ReVIEW
 
     basedir = Dir.pwd
     base_path = Pathname.new(basedir)
-    ReVIEW::Book.load(basedir).parts.each do |part|
+    book = ReVIEW::Book.load(basedir)
+    book.load_config(yamlfile)
+    book.parts.each do |part|
       htmlfile = nil
       if part.name.present?
         if part.file?
@@ -247,7 +250,7 @@ EOT
     end
     id = filename.sub(/\.re\Z/, "")
 
-    if @params["rename_for_legacy"] && ispart.nil?
+    if @params["epubmaker"]["rename_for_legacy"] && ispart.nil?
       if chap.on_PREDEF?
         @precount += 1
         id = sprintf("pre%02d", @precount)
@@ -281,22 +284,43 @@ EOT
       stylesheet = "--stylesheet=#{@params["stylesheet"].join(",")}"
     end
 
+    ENV["REVIEWFNAME"] = filename
     system("#{ReVIEW::MakerHelper.bindir}/review-compile --yaml=#{yamlfile} --target=html --level=#{level} --htmlversion=#{@params["htmlversion"]} --epubversion=#{@params["epubversion"]} #{stylesheet} #{@params["params"]} #{filename} > \"#{basetmpdir}/#{htmlfile}\"")
 
     write_info_body(basetmpdir, id, htmlfile, ispart, chaptype)
   end
 
+  def detect_properties(path)
+    properties = []
+    File.open(path) do |f|
+      doc = REXML::Document.new(f)
+      if REXML::XPath.first(doc, "//m:math", {'m' => 'http://www.w3.org/1998/Math/MathML'})
+        properties<< "mathml"
+      end
+      if REXML::XPath.first(doc, "//s:svg", {'s' => 'http://www.w3.org/2000/svg'})
+        properties<< "svg"
+      end
+    end
+    properties
+  end
+
   def write_info_body(basetmpdir, id, filename, ispart=nil, chaptype=nil)
     headlines = []
     # FIXME:nonumを修正する必要あり
-    Document.parse_stream(File.new("#{basetmpdir}/#{filename}"), ReVIEWHeaderListener.new(headlines))
+    path = File.join(basetmpdir, filename)
+    Document.parse_stream(File.new(path), ReVIEWHeaderListener.new(headlines))
+    properties = detect_properties(path)
+    prop_str = ""
+    if properties.present?
+      prop_str = ",properties="+properties.join(" ")
+    end
     first = true
     headlines.each do |headline|
       headline["level"] = 0 if !ispart.nil? && headline["level"] == 1
       if first.nil?
         write_tochtmltxt(basetmpdir, "#{headline["level"]}\t#{filename}##{headline["id"]}\t#{headline["title"]}\tchaptype=#{chaptype}")
       else
-        write_tochtmltxt(basetmpdir, "#{headline["level"]}\t#{filename}\t#{headline["title"]}\tforce_include=true,chaptype=#{chaptype}")
+        write_tochtmltxt(basetmpdir, "#{headline["level"]}\t#{filename}\t#{headline["title"]}\tforce_include=true,chaptype=#{chaptype}#{prop_str}")
         first = nil
       end
     end
@@ -308,6 +332,7 @@ EOT
         force_include = nil
         customid = nil
         chaptype = nil
+        properties = nil
         level, file, title, custom = l.chomp.split("\t")
         unless custom.nil?
           # custom setting
@@ -321,17 +346,22 @@ EOT
               force_include = true
             when "chaptype"
               chaptype = v
+            when "properties"
+              properties = v
             end
           end
         end
         next if level.to_i > @params["toclevel"] && force_include.nil?
         log("Push #{file} to ePUB contents.")
 
-        if customid.nil?
-          @epub.contents.push(Content.new("file" => file, "level" => level.to_i, "title" => title, "chaptype" => chaptype))
-        else
-          @epub.contents.push(Content.new("id" => customid, "file" => file, "level" => level.to_i, "title" => title, "chaptype" => chaptype))
+        hash = {"file" => file, "level" => level.to_i, "title" => title, "chaptype" => chaptype}
+        if customid.present?
+          hash["id"] = customid
+        end
+        if properties.present?
+          hash["properties"] = properties.split(" ")
         end
+        @epub.contents.push(Content.new(hash))
       end
     end
   end