review 1.5.0 → 1.6.0

data/doc/sample.yml

@@ -89,7 +89,10 @@ secnolevel: 2
 # 部番号を表示する見出しレベル(未実装)
 # part_secnolevel: 1
 
-# EPUB2標準の目次以外に物理目次ファイルを作成するか。省略した場合はnull (作成しない)
+# 本文中に目次ページを作成するか。省略した場合はnull (作成しない)
+# toc: true
+
+# EPUB2標準の目次(NCX)以外に物理目次ファイルを作成するか。省略した場合はnull (作成しない)
 # ePUB3においてはこの設定によらず必ず作成される
 # mytoc: true
 

data/lib/epubmaker/epubcommon.rb

@@ -12,6 +12,7 @@
 require 'epubmaker/producer'
 require 'review/i18n'
 require 'cgi'
+require 'shellwords'
 
 module EPUBMaker
 
@@ -389,10 +390,10 @@ EOT
     def produce_write_common(basedir, tmpdir)
       File.open("#{tmpdir}/mimetype", "w") {|f| @producer.mimetype(f) }
 
-      Dir.mkdir("#{tmpdir}/META-INF") unless File.exist?("#{tmpdir}/META-INF")
+      FileUtils.mkdir_p("#{tmpdir}/META-INF")
       File.open("#{tmpdir}/META-INF/container.xml", "w") {|f| @producer.container(f) }
 
-      Dir.mkdir("#{tmpdir}/OEBPS") unless File.exist?("#{tmpdir}/OEBPS")
+      FileUtils.mkdir_p("#{tmpdir}/OEBPS")
       File.open("#{tmpdir}/OEBPS/#{@producer.params["bookname"]}.opf", "w") {|f| @producer.opf(f) }
 
       if File.exist?("#{basedir}/#{@producer.params["cover"]}")
@@ -405,14 +406,14 @@ EOT
         next if item.file =~ /#/ # skip subgroup
         fname = "#{basedir}/#{item.file}"
         raise "#{fname} doesn't exist. Abort." unless File.exist?(fname)
-        FileUtils.mkdir_p(File.dirname("#{tmpdir}/OEBPS/#{item.file}")) unless File.exist?(File.dirname("#{tmpdir}/OEBPS/#{item.file}"))
+        FileUtils.mkdir_p(File.dirname("#{tmpdir}/OEBPS/#{item.file}"))
         FileUtils.cp(fname, "#{tmpdir}/OEBPS/#{item.file}")
       end
     end
 
     def export_zip(tmpdir, epubfile)
-      Dir.chdir(tmpdir) {|d| `#{@producer.params["epubmaker"]["zip_stage1"]} #{epubfile} mimetype` }
-      Dir.chdir(tmpdir) {|d| `#{@producer.params["epubmaker"]["zip_stage2"]} #{epubfile} META-INF OEBPS #{@producer.params["epubmaker"]["zip_addpath"]}` }
+      Dir.chdir(tmpdir) {|d| `#{@producer.params["epubmaker"]["zip_stage1"]} #{epubfile.shellescape} mimetype` }
+      Dir.chdir(tmpdir) {|d| `#{@producer.params["epubmaker"]["zip_stage2"]} #{epubfile.shellescape} META-INF OEBPS #{@producer.params["epubmaker"]["zip_addpath"]}` }
     end
 
     def legacy_cover_and_title_file(loadfile, writefile)

data/lib/epubmaker/epubv3.rb

@@ -126,7 +126,7 @@ EOT
 
       if @producer.params["coverimage"]
         @producer.contents.each do |item|
-          if item.media =~ /\Aimage/ && item.file =~ /#{@producer.params["coverimage"]}\Z/
+          if item.media =~ /\Aimage/ && File.basename(item.file) == @producer.params["coverimage"]
             s << %Q[    <item properties="cover-image" id="cover-#{item.id}" href="#{item.file}" media-type="#{item.media}"/>\n]
             item.id = nil
             break

data/lib/epubmaker/producer.rb

@@ -268,7 +268,7 @@ module EPUBMaker
         end
       end
 
-      @params["htmlversion"] == 5 if @params["epubversion"] >= 3
+      @params["htmlversion"] = 5 if @params["epubversion"] >= 3
 
       %w[bookname title].each do |k|
         raise "Key #{k} must have a value. Abort." if @params[k].nil?

data/lib/review/book/chapter.rb

@@ -93,7 +93,7 @@ module ReVIEW
 
       private
       def on_FILE?(contents)
-        contents.lines.map(&:strip).include?(id() + @book.ext())
+        contents.lines.map(&:strip).include?("#{id()}#{@book.ext()}")
       end
     end
   end

data/lib/review/book/index.rb

@@ -57,11 +57,12 @@ module ReVIEW
       def [](id)
         @index.fetch(id)
       rescue
-        if @index.keys.map{|i| i.split(/\|/) }.flatten. # unfold all ids
+        if @index.keys.map{|i| i.split(/\|/).last }.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

data/lib/review/builder.rb

@@ -104,9 +104,9 @@ module ReVIEW
       listnum_body lines, lang
     end
 
-    def source(lines, caption)
+    def source(lines, caption, lang = nil)
       source_header caption
-      source_body lines
+      source_body lines, lang
     end
 
     def image(lines, id, caption, metric = nil)
@@ -344,7 +344,7 @@ module ReVIEW
 
     def get_chap(chapter = @chapter)
       if @book.config["secnolevel"] > 0 && !chapter.number.nil? && !chapter.number.to_s.empty?
-        return "#{chapter.number}"
+        return chapter.format_number(nil)
       end
       return nil
     end

data/lib/review/compiler.rb

@@ -11,7 +11,6 @@
 require 'review/extentions'
 require 'review/preprocessor'
 require 'review/exception'
-require 'lineinput'
 require 'strscan'
 
 module ReVIEW
@@ -137,7 +136,7 @@ module ReVIEW
     defblock :table, 0..2
     defblock :quote, 0
     defblock :image, 2..3, true
-    defblock :source, 0..1
+    defblock :source, 0..2
     defblock :listnum, 2..3
     defblock :emlistnum, 0..2
     defblock :bibpaper, 2..3, true
@@ -409,6 +408,7 @@ module ReVIEW
         @strategy.dt text(f.gets.sub(/\A\s*:/, '').strip)
         @strategy.dd f.break(/\A(\S|\s*:)/).map {|line| text(line.strip) }
         f.skip_blank_lines
+        f.skip_comment_lines
       end
       @strategy.dl_end
     end

data/lib/review/epubmaker.rb

@@ -18,20 +18,20 @@ module ReVIEW
   include REXML
 
   def initialize
-    @epub = nil
+    @producer = nil
     @tochtmltxt = "toc-html.txt"
     @buildlogtxt = "build-log.txt"
   end
 
   def log(s)
-    puts s unless @params["debug"].nil?
+    puts s if @params["debug"].present?
   end
 
   def load_yaml(yamlfile)
     @params = ReVIEW::Configure.values.merge(YAML.load_file(yamlfile)) # FIXME:設定がRe:VIEW側とepubmaker/producer.rb側の2つに分かれて面倒
-    @epub = Producer.new(@params)
-    @epub.load(yamlfile)
-    @params = @epub.params
+    @producer = Producer.new(@params)
+    @producer.load(yamlfile)
+    @params = @producer.params
   end
 
   def produce(yamlfile, bookname=nil)
@@ -42,33 +42,31 @@ module ReVIEW
 
     log("Loaded yaml file (#{yamlfile}). I will produce #{bookname}.epub.")
 
-    File.unlink("#{bookname}.epub") if File.exist?("#{bookname}.epub")
-    FileUtils.rm_rf(booktmpname) if @params["debug"] && File.exist?(booktmpname)
+    FileUtils.rm_f("#{bookname}.epub")
+    FileUtils.rm_rf(booktmpname) if @params["debug"]
 
     basetmpdir = Dir.mktmpdir("#{bookname}-", Dir.pwd)
     begin
       log("Created first temporary directory as #{basetmpdir}.")
 
-      log("Call hook_beforeprocess. (#{@params["epubmaker"]["hook_beforeprocess"]})")
-      call_hook(@params["epubmaker"]["hook_beforeprocess"], basetmpdir)
+      call_hook("hook_beforeprocess", basetmpdir)
 
+      ## copy all files into basetmpdir
       copy_stylesheet(basetmpdir)
 
       copy_frontmatter(basetmpdir)
-      log("Call hook_afterfrontmatter. (#{@params["epubmaker"]["hook_afterfrontmatter"]})")
-      call_hook(@params["epubmaker"]["hook_afterfrontmatter"], basetmpdir)
+      call_hook("hook_afterfrontmatter", basetmpdir)
 
       build_body(basetmpdir, yamlfile)
-      log("Call hook_afterbody. (#{@params["epubmaker"]["hook_afterbody"]})")
-      call_hook(@params["epubmaker"]["hook_afterbody"], basetmpdir)
+      call_hook("hook_afterbody", basetmpdir)
 
       copy_backmatter(basetmpdir)
-      log("Call hook_afterbackmatter. (#{@params["epubmaker"]["hook_afterbackmatter"]})")
-      call_hook(@params["epubmaker"]["hook_afterbackmatter"], basetmpdir)
+      call_hook("hook_afterbackmatter", basetmpdir)
 
+      ## push contents in basetmpdir into @producer
       push_contents(basetmpdir)
 
-      if !@params["epubmaker"]["verify_target_images"].nil?
+      if @params["epubmaker"]["verify_target_images"].present?
         verify_target_images(basetmpdir)
         copy_images(@params["imagedir"], basetmpdir)
       else
@@ -79,24 +77,28 @@ module ReVIEW
       copy_resources("adv", "#{basetmpdir}/images")
       copy_resources(@params["fontdir"], "#{basetmpdir}/fonts", @params["font_ext"])
 
-      log("Call hook_aftercopyimage. (#{@params["epubmaker"]["hook_aftercopyimage"]})")
-      call_hook(@params["epubmaker"]["hook_aftercopyimage"], basetmpdir)
+      call_hook("hook_aftercopyimage", basetmpdir)
 
-      @epub.import_imageinfo("#{basetmpdir}/images", basetmpdir)
-      @epub.import_imageinfo("#{basetmpdir}/fonts", basetmpdir, @params["font_ext"])
+      @producer.import_imageinfo("#{basetmpdir}/images", basetmpdir)
+      @producer.import_imageinfo("#{basetmpdir}/fonts", basetmpdir, @params["font_ext"])
 
-      epubtmpdir = @params["debug"].nil? ? nil : "#{Dir.pwd}/#{booktmpname}"
-      Dir.mkdir(booktmpname) unless @params["debug"].nil?
+      epubtmpdir = nil
+      if @params["debug"].present?
+        epubtmpdir = "#{Dir.pwd}/#{booktmpname}"
+        Dir.mkdir(epubtmpdir)
+      end
       log("Call ePUB producer.")
-      @epub.produce("#{bookname}.epub", basetmpdir, epubtmpdir)
+      @producer.produce("#{bookname}.epub", basetmpdir, epubtmpdir)
       log("Finished.")
     ensure
       FileUtils.remove_entry_secure basetmpdir if @params["debug"].nil?
     end
   end
 
-  def call_hook(filename, *params)
-    if !filename.nil? && File.exist?(filename) && FileTest.executable?(filename)
+  def call_hook(hook_name, *params)
+    filename = @params["epubmaker"][hook_name]
+    log("Call #{hook_name}. (#{filename})")
+    if filename.present? && File.exist?(filename) && FileTest.executable?(filename)
       if ENV["REVIEW_SAFE_MODE"].to_i & 1 > 0
         warn "hook is prohibited in safe mode. ignored."
       else
@@ -106,7 +108,7 @@ module ReVIEW
   end
 
   def verify_target_images(basetmpdir)
-    @epub.contents.each do |content|
+    @producer.contents.each do |content|
       if content.media == "application/xhtml+xml"
 
         File.open("#{basetmpdir}/#{content.file}") do |f|
@@ -133,15 +135,15 @@ module ReVIEW
   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["epubmaker"]["verify_target_images"].nil?
+    FileUtils.mkdir_p(destdir)
+    if @params["epubmaker"]["verify_target_images"].present?
       @params["epubmaker"]["force_include_images"].each do |file|
         unless File.exist?(file)
           warn "#{file} is not found, skip." if file !~ /\Ahttp[s]?:/
           next
         end
         basedir = File.dirname(file)
-        FileUtils.mkdir_p("#{destdir}/#{basedir}") unless FileTest.directory?("#{destdir}/#{basedir}")
+        FileUtils.mkdir_p("#{destdir}/#{basedir}")
         log("Copy #{file} to the temporary directory.")
         FileUtils.cp(file, "#{destdir}/#{basedir}")
       end
@@ -153,7 +155,7 @@ module ReVIEW
   def copy_resources(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)
+    FileUtils.mkdir_p(destdir)
     recursive_copy_files(resdir, destdir, allow_exts)
   end
 
@@ -165,7 +167,7 @@ module ReVIEW
           recursive_copy_files("#{resdir}/#{fname}", "#{destdir}/#{fname}", allow_exts)
         else
           if fname =~ /\.(#{allow_exts.join("|")})\Z/i
-            FileUtils.mkdir_p(destdir) unless File.exist?(destdir)
+            FileUtils.mkdir_p(destdir)
             log("Copy #{resdir}/#{fname} to the temporary directory.")
             FileUtils.cp("#{resdir}/#{fname}", destdir)
           end
@@ -235,7 +237,7 @@ EOT
     filename = ""
 
     chaptype = "body"
-    if !ispart.nil?
+    if ispart.present?
       chaptype = "part"
     elsif chap.on_PREDEF?
       chaptype = "pre"
@@ -243,7 +245,7 @@ EOT
       chaptype = "post"
     end
 
-    if !ispart.nil?
+    if ispart.present?
       filename = chap.path
     else
       filename = Pathname.new(chap.path).relative_path_from(base_path).to_s
@@ -316,7 +318,7 @@ EOT
     end
     first = true
     headlines.each do |headline|
-      headline["level"] = 0 if !ispart.nil? && headline["level"] == 1
+      headline["level"] = 0 if ispart.present? && headline["level"] == 1
       if first.nil?
         write_tochtmltxt(basetmpdir, "#{headline["level"]}\t#{filename}##{headline["id"]}\t#{headline["title"]}\tchaptype=#{chaptype}")
       else
@@ -334,7 +336,7 @@ EOT
         chaptype = nil
         properties = nil
         level, file, title, custom = l.chomp.split("\t")
-        unless custom.nil?
+        if custom.present?
           # custom setting
           vars = custom.split(/,\s*/)
           vars.each do |var|
@@ -361,7 +363,7 @@ EOT
         if properties.present?
           hash["properties"] = properties.split(" ")
         end
-        @epub.contents.push(Content.new(hash))
+        @producer.contents.push(Content.new(hash))
       end
     end
   end
@@ -370,13 +372,13 @@ EOT
     if @params["stylesheet"].size > 0
       @params["stylesheet"].each do |sfile|
         FileUtils.cp(sfile, basetmpdir)
-        @epub.contents.push(Content.new("file" => sfile))
+        @producer.contents.push(Content.new("file" => sfile))
       end
     end
   end
 
   def copy_frontmatter(basetmpdir)
-    FileUtils.cp(@params["cover"], "#{basetmpdir}/#{File.basename(@params["cover"])}") if !@params["cover"].nil? && File.exist?(@params["cover"])
+    FileUtils.cp(@params["cover"], "#{basetmpdir}/#{File.basename(@params["cover"])}") if @params["cover"].present? && File.exist?(@params["cover"])
 
     if @params["titlepage"]
       if @params["titlefile"].nil?
@@ -384,17 +386,17 @@ EOT
       else
         FileUtils.cp(@params["titlefile"], "#{basetmpdir}/titlepage.#{@params["htmlext"]}")
       end
-      write_tochtmltxt(basetmpdir, "1\ttitlepage.#{@params["htmlext"]}\t#{@epub.res.v("titlepagetitle")}\tchaptype=pre")
+      write_tochtmltxt(basetmpdir, "1\ttitlepage.#{@params["htmlext"]}\t#{@producer.res.v("titlepagetitle")}\tchaptype=pre")
     end
 
-    if !@params["originaltitlefile"].nil? && File.exist?(@params["originaltitlefile"])
+    if @params["originaltitlefile"].present? && File.exist?(@params["originaltitlefile"])
       FileUtils.cp(@params["originaltitlefile"], "#{basetmpdir}/#{File.basename(@params["originaltitlefile"])}")
-      write_tochtmltxt(basetmpdir, "1\t#{File.basename(@params["originaltitlefile"])}\t#{@epub.res.v("originaltitle")}\tchaptype=pre")
+      write_tochtmltxt(basetmpdir, "1\t#{File.basename(@params["originaltitlefile"])}\t#{@producer.res.v("originaltitle")}\tchaptype=pre")
     end
 
-    if !@params["creditfile"].nil? && File.exist?(@params["creditfile"])
+    if @params["creditfile"].present? && File.exist?(@params["creditfile"])
       FileUtils.cp(@params["creditfile"], "#{basetmpdir}/#{File.basename(@params["creditfile"])}")
-      write_tochtmltxt(basetmpdir, "1\t#{File.basename(@params["creditfile"])}\t#{@epub.res.v("credittitle")}\tchaptype=pre")
+      write_tochtmltxt(basetmpdir, "1\t#{File.basename(@params["creditfile"])}\t#{@producer.res.v("credittitle")}\tchaptype=pre")
     end
   end
 
@@ -427,26 +429,26 @@ EOT
   def copy_backmatter(basetmpdir)
     if @params["profile"]
       FileUtils.cp(@params["profile"], "#{basetmpdir}/#{File.basename(@params["profile"])}")
-      write_tochtmltxt(basetmpdir, "1\t#{File.basename(@params["profile"])}\t#{@epub.res.v("profiletitle")}\tchaptype=post")
+      write_tochtmltxt(basetmpdir, "1\t#{File.basename(@params["profile"])}\t#{@producer.res.v("profiletitle")}\tchaptype=post")
     end
 
     if @params["advfile"]
       FileUtils.cp(@params["advfile"], "#{basetmpdir}/#{File.basename(@params["advfile"])}")
-      write_tochtmltxt(basetmpdir, "1\t#{File.basename(@params["advfile"])}\t#{@epub.res.v("advtitle")}\tchaptype=post")
+      write_tochtmltxt(basetmpdir, "1\t#{File.basename(@params["advfile"])}\t#{@producer.res.v("advtitle")}\tchaptype=post")
     end
 
     if @params["colophon"]
       if @params["colophon"].instance_of?(String) # FIXME:このやり方はやめる？
         FileUtils.cp(@params["colophon"], "#{basetmpdir}/colophon.#{@params["htmlext"]}")
       else
-        File.open("#{basetmpdir}/colophon.#{@params["htmlext"]}", "w") {|f| @epub.colophon(f) }
+        File.open("#{basetmpdir}/colophon.#{@params["htmlext"]}", "w") {|f| @producer.colophon(f) }
       end
-      write_tochtmltxt(basetmpdir, "1\tcolophon.#{@params["htmlext"]}\t#{@epub.res.v("colophontitle")}\tchaptype=post")
+      write_tochtmltxt(basetmpdir, "1\tcolophon.#{@params["htmlext"]}\t#{@producer.res.v("colophontitle")}\tchaptype=post")
     end
 
     if @params["backcover"]
       FileUtils.cp(@params["backcover"], "#{basetmpdir}/#{File.basename(@params["backcover"])}")
-      write_tochtmltxt(basetmpdir, "1\t#{File.basename(@params["backcover"])}\t#{@epub.res.v("backcovertitle")}\tchaptype=post")
+      write_tochtmltxt(basetmpdir, "1\t#{File.basename(@params["backcover"])}\t#{@producer.res.v("backcovertitle")}\tchaptype=post")
     end
   end
 
@@ -515,15 +517,15 @@ EOT
 
     def tag_start(name, attrs)
       if name =~ /\Ah(\d+)/
-        unless @level.nil?
+        if @level.present?
           raise "#{name}, #{attrs}"
         end
         @level = $1.to_i
-        @id = attrs["id"] if !attrs["id"].nil?
+        @id = attrs["id"] if attrs["id"].present?
       elsif !@level.nil?
-        if name == "img" && !attrs["alt"].nil?
+        if name == "img" && attrs["alt"].present?
           @content << attrs["alt"]
-        elsif name == "a" && !attrs["id"].nil?
+        elsif name == "a" && attrs["id"].present?
           @id = attrs["id"]
         end
       end
@@ -531,7 +533,7 @@ EOT
 
     def tag_end(name)
       if name =~ /\Ah\d+/
-        @headlines.push({"level" => @level, "id" => @id, "title" => @content}) unless @id.nil?
+        @headlines.push({"level" => @level, "id" => @id, "title" => @content}) if @id.present?
         @content = ""
         @level = nil
         @id = nil
@@ -539,7 +541,7 @@ EOT
     end
 
     def text(text)
-      unless @level.nil?
+      if @level.present?
         @content << text.gsub("\t", "　") # FIXME:区切り文字
       end
     end

data/lib/review/htmlbuilder.rb

@@ -193,6 +193,9 @@ EOT
 
     def headline(level, label, caption)
       prefix, anchor = headline_prefix(level)
+      unless prefix.nil?
+        prefix = %Q[<span class="secno">#{prefix}</span>]
+      end
       puts '' if level > 1
       a_id = ""
       unless anchor.nil?
@@ -453,10 +456,10 @@ EOT
       puts '</pre>'
     end
 
-    def source(lines, caption = nil)
+    def source(lines, caption = nil, lang = nil)
       puts %Q[<div class="source-code">]
       source_header caption
-      source_body caption, lines
+      source_body caption, lines, lang
       puts '</div>'
     end
 
@@ -466,11 +469,11 @@ EOT
       end
     end
 
-    def source_body(id, lines)
+    def source_body(id, lines, lang)
       id ||= ''
       print %Q[<pre class="source">]
       body = lines.inject(''){|i, j| i + detab(j) + "\n"}
-      lexer = File.extname(id).gsub(/\./, '')
+      lexer = lang || File.extname(id).gsub(/\./, '')
       puts highlight(:body => body, :lexer => lexer, :format => 'html')
       puts '</pre>'
     end
@@ -942,9 +945,9 @@ QUOTE
     def inline_hd_chap(chap, id)
       n = chap.headline_index.number(id)
       if chap.number and @book.config["secnolevel"] >= n.split('.').size
-        str = "「#{n} #{compile_inline(chap.headline(id).caption)}」"
+        str = I18n.t("chapter_quote", "#{n} #{compile_inline(chap.headline(id).caption)}")
       else
-        str = "「#{compile_inline(chap.headline(id).caption)}」"
+        str = I18n.t("chapter_quote", compile_inline(chap.headline(id).caption))
       end
       if @book.config["chapterlink"]
         anchor = "h"+n.gsub(/\./, "-")