RubyGems - tmtms-review - Versions diffs - 1.0.0 - Mend

tmtms-review 1.0.0

Files changed (107) hide show

checksums.yaml +7 -0
data/.travis.yml +9 -0
data/COPYING +515 -0
data/ChangeLog +2083 -0
data/README.rdoc +50 -0
data/Rakefile +56 -0
data/VERSION +1 -0
data/bin/review-check +178 -0
data/bin/review-checkdep +63 -0
data/bin/review-compile +205 -0
data/bin/review-epubmaker +661 -0
data/bin/review-epubmaker-ng +176 -0
data/bin/review-index +118 -0
data/bin/review-pdfmaker +208 -0
data/bin/review-preproc +142 -0
data/bin/review-validate +51 -0
data/bin/review-vol +102 -0
data/debian/README.Debian +12 -0
data/debian/README.source +5 -0
data/debian/changelog +5 -0
data/debian/compat +1 -0
data/debian/control +22 -0
data/debian/copyright +62 -0
data/debian/docs +6 -0
data/debian/manpage.1.ex +59 -0
data/debian/patches/path.diff +91 -0
data/debian/patches/series +1 -0
data/debian/review.install +13 -0
data/debian/review.links +4 -0
data/debian/rules +13 -0
data/debian/source/format +1 -0
data/doc/format.rdoc +582 -0
data/doc/format_idg.rdoc +180 -0
data/doc/libepubmaker/sample.yaml +90 -0
data/doc/quickstart.rdoc +188 -0
data/doc/ruby-uuid/README +11 -0
data/doc/ruby-uuid/README.ja +34 -0
data/doc/sample.css +108 -0
data/doc/sample.yaml +62 -0
data/lib/epubmaker.rb +28 -0
data/lib/epubmaker/content.rb +82 -0
data/lib/epubmaker/epubv2.rb +418 -0
data/lib/epubmaker/epubv3.rb +249 -0
data/lib/epubmaker/producer.rb +204 -0
data/lib/epubmaker/resource.rb +66 -0
data/lib/lineinput.rb +155 -0
data/lib/review.rb +3 -0
data/lib/review/book.rb +46 -0
data/lib/review/book/base.rb +235 -0
data/lib/review/book/chapter.rb +81 -0
data/lib/review/book/compilable.rb +159 -0
data/lib/review/book/index.rb +339 -0
data/lib/review/book/page_metric.rb +38 -0
data/lib/review/book/parameters.rb +97 -0
data/lib/review/book/part.rb +44 -0
data/lib/review/book/volume.rb +65 -0
data/lib/review/builder.rb +444 -0
data/lib/review/compiler.rb +550 -0
data/lib/review/configure.rb +38 -0
data/lib/review/epubbuilder.rb +18 -0
data/lib/review/exception.rb +21 -0
data/lib/review/extentions.rb +3 -0
data/lib/review/extentions/object.rb +9 -0
data/lib/review/extentions/string.rb +33 -0
data/lib/review/htmlbuilder.rb +1097 -0
data/lib/review/htmllayout.rb +19 -0
data/lib/review/htmlutils.rb +36 -0
data/lib/review/i18n.rb +30 -0
data/lib/review/i18n.yaml +34 -0
data/lib/review/idgxmlbuilder.rb +1145 -0
data/lib/review/latexbuilder.rb +815 -0
data/lib/review/latexindex.rb +35 -0
data/lib/review/latexutils.rb +79 -0
data/lib/review/preprocessor.rb +563 -0
data/lib/review/review.tex.erb +232 -0
data/lib/review/textbuilder.rb +17 -0
data/lib/review/textutils.rb +66 -0
data/lib/review/tocparser.rb +342 -0
data/lib/review/tocprinter.rb +221 -0
data/lib/review/topbuilder.rb +785 -0
data/lib/review/unfold.rb +138 -0
data/lib/uuid.rb +312 -0
data/review.gemspec +141 -0
data/test/CHAPS +2 -0
data/test/bib.re +13 -0
data/test/book_test_helper.rb +35 -0
data/test/test.re +43 -0
data/test/test_book.rb +598 -0
data/test/test_book_chapter.rb +418 -0
data/test/test_book_parameter.rb +42 -0
data/test/test_book_part.rb +50 -0
data/test/test_builder.rb +144 -0
data/test/test_compiler.rb +44 -0
data/test/test_epubmaker.rb +507 -0
data/test/test_helper.rb +27 -0
data/test/test_htmlbuilder.rb +554 -0
data/test/test_htmlutils.rb +28 -0
data/test/test_i18n.rb +64 -0
data/test/test_idgxmlbuilder.rb +589 -0
data/test/test_index.rb +31 -0
data/test/test_latexbuilder.rb +656 -0
data/test/test_lineinput.rb +198 -0
data/test/test_preprocessor.rb +23 -0
data/test/test_textutils.rb +68 -0
data/test/test_topbuilder.rb +244 -0
data/test/test_uuid.rb +156 -0
metadata +161 -0

@@ -0,0 +1,249 @@
+# encoding: utf-8
+# = epubv3.rb -- EPUB version 3 producer.
+#
+# Copyright (c) 2010 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 'epubmaker/epubv2'
+module EPUBMaker
+  # EPUBv3 is EPUB version 3 producer.
+  class EPUBv3 < EPUBv2
+    def ncx(indentarray)
+      # FIXME: handle indentarray
+      s = common_header
+      s << <<EOT
+  <title>#{@producer.res.v("toctitle")}</title>
+</head>
+<body>
+  <nav epub:type="toc" id="toc">
+  <h1 class="toc-title">#{@producer.res.v("toctitle")}</h1>
+  <ul class="toc-h1">
+EOT
+      current = 1
+      init_item = true
+      @producer.contents.each do |item|
+        next if !item.notoc.nil? || item.level.nil? || item.file.nil? || item.title.nil? || item.level > @producer.params["toclevel"].to_i
+        if item.level > current
+          s << %Q[\n<ul class="toc-h#{item.level}">\n]
+          current = item.level
+        elsif item.level < current
+          (current - 1).downto(item.level) do |n|
+            s << %Q[</li>\n</ul>\n]
+          end
+          s << %Q[</li>\n]
+          current = item.level
+        elsif init_item
+          # noop
+        else
+          s << %Q[</li>\n]
+        end
+        s << %Q[<li><a href="#{item.file}">#{item.title}</a>]
+        init_item = false
+      end
+      (current - 1).downto(1) do |n|
+        s << %Q[</li>\n</ul>\n]
+      end
+      if !init_item
+      s << %Q[</li>\n]
+      end
+      s << <<EOT
+  </ul>
+  </nav>
+</body>
+</html>
+EOT
+      return s
+    end
+    # Produce EPUB file +epubfile+.
+    # +basedir+ points the directory has contents.
+    # +tmpdir+ defines temporary directory.
+    def produce(epubfile, basedir, tmpdir)
+      File.open("#{tmpdir}/mimetype", "w") {|f| @producer.mimetype(f) }
+      Dir.mkdir("#{tmpdir}/META-INF") unless File.exist?("#{tmpdir}/META-INF")
+      File.open("#{tmpdir}/META-INF/container.xml", "w") {|f| @producer.container(f) }
+      Dir.mkdir("#{tmpdir}/OEBPS") unless File.exist?("#{tmpdir}/OEBPS")
+      File.open("#{tmpdir}/OEBPS/#{@producer.params["bookname"]}.opf", "w") {|f| @producer.opf(f) }
+      File.open("#{tmpdir}/OEBPS/#{@producer.params["bookname"]}-toc.#{@producer.params["htmlext"]}", "w") {|f| @producer.ncx(f, @producer.params["ncxindent"]) }
+#      File.open("#{tmpdir}/OEBPS/#{@producer.params["tocfile"]}", "w") {|f| @producer.mytoc(f) } unless @producer.params["mytoc"].nil?
+      if File.exist?("#{basedir}/#{@producer.params["cover"]}")
+        FileUtils.cp("#{basedir}/#{@producer.params["cover"]}", "#{tmpdir}/OEBPS")
+      else
+        File.open("#{tmpdir}/OEBPS/#{@producer.params["cover"]}", "w") {|f| @producer.cover(f) }
+      end
+      # FIXME:colophon and titlepage should be included in @producer.contents.
+      @producer.contents.each do |item|
+        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.cp(fname, "#{tmpdir}/OEBPS/#{item.file}")
+      end
+      fork {
+        Dir.chdir(tmpdir) {|d|
+          exec("zip", "-0X", "#{epubfile}", "mimetype")
+        }
+      }
+      Process.waitall
+      fork {
+        Dir.chdir(tmpdir) {|d|
+          exec("zip", "-Xr9D", "#{epubfile}", "META-INF", "OEBPS")
+        }
+      }
+      Process.waitall
+    end
+    # Return opf file content.
+    def opf
+      mathstr = @producer.params["mathml"].nil? ? "" : %Q[ properties="mathml"]
+      s = <<EOT
+<?xml version="1.0" encoding="UTF-8"?>
+<package version="3.0" xmlns="http://www.idpf.org/2007/opf" unique-identifier="BookId" xml:lang="#{@producer.params["language"]}" profile="http://www.idpf.org/epub/30/profile/package/">
+  <metadata xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:opf="http://www.idpf.org/2007/opf">
+EOT
+      %w[title language date type format source description relation coverage subject rights].each do |item|
+        next if @producer.params[item].nil?
+        if @producer.params[item].instance_of?(Array)
+          s << @producer.params[item].map {|i| %Q[    <dc:#{item} prefer="#{item}">#{CGI.escapeHTML(i.to_s)}</dc:#{item}>\n]}.join
+          s << @producer.params[item].map {|i| %Q[    <meta id="#{item}" property="dcterms:#{item}">#{CGI.escapeHTML(i.to_s)}</meta>\n]}.join
+        else
+          s << %Q[    <dc:#{item} prefer="#{item}">#{CGI.escapeHTML(@producer.params[item].to_s)}</dc:#{item}>\n]
+          s << %Q[    <meta id="#{item}" property="dcterms:#{item}">#{CGI.escapeHTML(@producer.params[item].to_s)}</meta>\n]
+        end
+      end
+      # ID
+      if @producer.params["isbn"].nil?
+        s << %Q[    <dc:identifier id="BookId" prefer="bookid">#{@producer.params["urnid"]}</dc:identifier>\n]
+        s << %Q[    <meta property="dcterms:identifier" id="bookid">#{@producer.params["urnid"]}</meta>\n]
+      else
+        s << %Q[    <dc:identifier id="BookId" opf:scheme="ISBN" prefer="bookid">#{@producer.params["isbn"]}</dc:identifier>\n]
+        s << %Q[    <meta property="dcterms:identifier" id="bookid" opf:scheme="ISBN">#{@producer.params["isbn"]}</meta>\n]
+      end
+      # creator
+      %w[aut a-adp a-ann a-arr a-art a-asn a-aqt a-aft a-aui a-ant a-bkp a-clb a-cmm a-dsr a-edt a-ill a-lyr a-mdc a-mus a-nrt a-oth a-pht a-prt a-red a-rev a-spn a-ths a-trc a-trl].each do |role|
+        next if @producer.params[role].nil?
+        @producer.params[role].each_with_index do |v, i|
+          s << %Q[    <dc:creator opf:role="#{role.sub('a-', '')}" prefer="creator-#{i}">#{CGI.escapeHTML(v)}</dc:creator>\n]
+          s << %Q[    <meta property="dcterms:creator" id="creator-#{i}" opf:role="#{role.sub('a-', '')}">#{CGI.escapeHTML(v)}</meta>\n]
+        end
+      end
+      # contributor
+      %w[adp ann arr art asn aqt aft aui ant bkp clb cmm dsr edt ill lyr mdc mus nrt oth pht prt red rev spn ths trc trl].each do |role|
+        next if @producer.params[role].nil?
+        @producer.params[role].each_with_index do |v, i|
+          s << %Q[    <dc:contributor opf:role="#{role}" prefer="contributor-#{i}">#{CGI.escapeHTML(v)}</dc:contributor>\n]
+          s << %Q[    <meta property="dcterms:contributor" id="contributor-#{i}" opf:role="#{role}">#{CGI.escapeHTML(v)}</meta>\n]
+          if role == "prt"
+            s << %Q[    <dc:publisher prefer="publisher">#{CGI.escapeHTML(v)}</dc:publisher>\n]
+            s << %Q[    <meta property="dcterms:publisher" id="publisher">#{CGI.escapeHTML(v)}</meta>\n]
+          end
+        end
+      end
+      s << %Q[  </metadata>\n]
+      # manifest
+      s << <<EOT
+  <manifest>
+    <item properties="nav#{mathstr.empty? ? '' : ' mathml'}" id="#{@producer.params["bookname"]}-toc.#{@producer.params["htmlext"]}" href="#{@producer.params["bookname"]}-toc.#{@producer.params["htmlext"]}" media-type="application/xhtml+xml"/>
+    <item id="#{@producer.params["bookname"]}" href="#{@producer.params["cover"]}" media-type="application/xhtml+xml"/>
+EOT
+      if @producer.params["coverimage"]
+        @producer.contents.each do |item|
+          if item.media =~ /\Aimage/ && item.file =~ /#{@producer.params["coverimage"]}\Z/
+              s << %Q[    <item properties="cover-image" id="#{item.id}" href="#{item.file}" media-type="#{item.media}"/>\n]
+            break
+          end
+        end
+      end
+#      s << %Q[    <item id="toc" href="#{@producer.params["tocfile"]}" media-type="application/xhtml+xml"/>\n] unless @producer.params["mytoc"].nil?
+      @producer.contents.each do |item|
+        next if item.file =~ /#/ # skip subgroup
+        s << %Q[    <item#{mathstr} id="#{item.id}" href="#{item.file}" media-type="#{item.media}"/>\n]
+      end
+      s << %Q[  </manifest>\n]
+      # tocx
+      s << %Q[  <spine>\n]
+      s << %Q[    <itemref idref="#{@producer.params["bookname"]}" linear="no"/>\n]
+      s << %Q[    <itemref idref="#{@producer.params["bookname"]}-toc.#{@producer.params["htmlext"]}" />\n] unless @producer.params["mytoc"].nil?
+      @producer.contents.each do |item|
+        next if item.media !~ /xhtml\+xml/ # skip non XHTML
+        s << %Q[    <itemref idref="#{item.id}"/>\n] if item.notoc.nil?
+      end
+      s << %Q[  </spine>\n]
+      # guide
+      s << %Q[  <guide>\n]
+      s << %Q[    <reference type="cover" title="#{@producer.res.v("covertitle")}" href="#{@producer.params["cover"]}"/>\n]
+      s << %Q[    <reference type="title-page" title="#{@producer.res.v("titlepagetitle")}" href="#{@producer.params["titlepage"]}"/>\n] unless @producer.params["titlepage"].nil?
+      s << %Q[    <reference type="toc" title="#{@producer.res.v("toctitle")}" href="#{@producer.params["bookname"]}-toc.#{@producer.params["htmlext"]}"/>\n] unless @producer.params["mytoc"].nil?
+      s << %Q[    <reference type="colophon" title="#{@producer.res.v("colophontitle")}" href="colophon.#{@producer.params["htmlext"]}"/>\n] unless @producer.params["colophon"].nil? # FIXME: path
+      s << %Q[  </guide>\n]
+      s << %Q[</package>\n]
+      return s
+    end
+    private
+    # Return cover pointer for opf file
+    def cover_in_opf
+      s = ""
+      if @producer.params["coverimage"]
+        @producer.contents.each do |item|
+          if item.media =~ /\Aimage/ && item.file =~ /#{@producer.params["coverimage"]}\Z/
+              s << <<EOT
+            <item id="#{item.id}" href="#{item.file}" media-type="#{item.media}"/>
+EOT
+            break
+          end
+        end
+      end
+      s << <<EOT
+    <item id="#{@producer.params["bookname"]}" href="#{@producer.params["cover"]}" media-type="application/xhtml+xml"/>
+EOT
+      return s
+    end
+    def common_header
+      s =<<EOT
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2011/epub" xmlns:ops="http://www.idpf.org/2007/ops" xml:lang="#{@producer.params["language"]}">
+<head>
+  <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/>
+  <meta http-equiv="Content-Style-Type" content="text/css"/>
+  <meta name="generator" content="EPUBMaker::Producer"/>
+EOT
+      @producer.params["stylesheet"].each do |file|
+        s << %Q[  <link rel="stylesheet" type="text/css" href="#{file}"/>\n]
+      end
+      return s
+    end
+  end
+end

data/lib/epubmaker/producer.rb ADDED

@@ -0,0 +1,204 @@
+# encoding: utf-8
+# = producer.rb -- EPUB producer.
+#
+# Copyright (c) 2010 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 'tmpdir'
+require 'fileutils'
+require 'yaml'
+require 'uuid'
+require 'epubmaker/resource'
+require 'epubmaker/content'
+require 'epubmaker/epubv2'
+require 'epubmaker/epubv3'
+module EPUBMaker
+  # EPUBMaker produces EPUB file.
+  class Producer
+    # Array of content objects.
+    attr_accessor :contents
+    # Parameter hash.
+    attr_accessor :params
+    # Message resource object.
+    attr_accessor :res
+    # Take YAML +file+ and return parameter hash.
+    def Producer.load(file)
+      raise "Can't open #{yamlfile}." if file.nil? || !File.exist?(file)
+      return YAML.load_file(file)
+    end
+    # Take YAML +file+ and update parameter hash.
+    def load(file)
+      raise "Can't open #{yamlfile}." if file.nil? || !File.exist?(file)
+      mergeparams(@params.merge(YAML.load_file(file)))
+    end
+    # Construct producer object.
+    # +params+ takes initial parameter hash. This parameters can be overriden by EPUBMaker#load or EPUBMaker#mergeparams.
+    # +version+ takes EPUB version (default is 2).
+    def initialize(params=nil, version=nil)
+      @contents = []
+      @params = {}
+      @epub = nil
+      @params["epubversion"] = version unless version.nil?
+      unless params.nil?
+        mergeparams(params)
+      end
+    end
+    # Update parameters by merging from new parameter hash +params+.
+    def mergeparams(params)
+      @params = @params.merge(params)
+      complement
+      @res = EPUBMaker::Resource.new(@params)
+      unless @params["epubversion"].nil?
+        case @params["epubversion"].to_i
+        when 2
+          @epub = EPUBMaker::EPUBv2.new(self)
+        when 3
+          @epub = EPUBMaker::EPUBv3.new(self)
+        else
+          raise "Invalid EPUB version (#{@params["epubversion"]}.)"
+        end
+      end
+    end
+    # Write mimetype file to IO object +wobj+.
+    def mimetype(wobj)
+      s = @epub.mimetype
+      wobj.print s if !s.nil? && !wobj.nil?
+    end
+    # Write opf file to IO object +wobj+.
+    def opf(wobj)
+      s = @epub.opf
+      wobj.puts s if !s.nil? && !wobj.nil?
+    end
+    # Write ncx file to IO object +wobj+. +indentarray+ defines prefix
+    # string for each level.
+    def ncx(wobj, indentarray=[])
+      s = @epub.ncx(indentarray)
+      wobj.puts s if !s.nil? && !wobj.nil?
+    end
+    # Write container file to IO object +wobj+.
+    def container(wobj)
+      s = @epub.container
+      wobj.puts s if !s.nil? && !wobj.nil?
+    end
+    # Write cover file to IO object +wobj+.
+    # If Producer#params["coverimage"] is defined, it will be used for
+    # the cover image.
+    def cover(wobj)
+      s = @epub.cover
+      wobj.puts s if !s.nil? && !wobj.nil?
+    end
+    # Write title file (copying) to IO object +wobj+.
+    def titlepage(wobj)
+      s = @epub.titlepage
+      wobj.puts s if !s.nil? && !wobj.nil?
+    end
+    # Write colophon file to IO object +wobj+.
+    def colophon(wobj)
+      s = @epub.colophon
+      wobj.puts s if !s.nil? && !wobj.nil?
+    end
+    # Write own toc file to IO object +wobj+.
+    def mytoc(wobj)
+      s = @epub.mytoc
+      wobj.puts s if !s.nil? && !wobj.nil?
+    end
+    # Add informations of figure files in +path+ to contents array.
+    # +base+ defines a string to remove from path name.
+    def importImageInfo(path, base=nil)
+      Dir.foreach(path) do |f|
+        next if f =~ /\A\./
+        if f =~ /\.(png|jpg|jpeg|svg|gif)\Z/i  # FIXME:EPUB3 accepts more types...
+          path.chop! if path =~ /\/\Z/
+          if base.nil?
+            @contents.push(EPUBMaker::Content.new({"file" => "#{path}/#{f}"}))
+          else
+            @contents.push(EPUBMaker::Content.new({"file" => "#{path.sub(base + "/", '')}/#{f}"}))
+          end
+        end
+        if FileTest.directory?("#{path}/#{f}")
+          importImageInfo("#{path}/#{f}", base)
+        end
+      end
+    end
+    # Produce EPUB file +epubfile+.
+    # +basedir+ points the directory has contents (default: current directory.)
+    # +tmpdir+ defines temporary directory.
+    def produce(epubfile, basedir=nil, tmpdir=nil)
+      current = Dir.pwd
+      basedir = current if basedir.nil?
+      # FIXME: produce cover, mytoc, titlepage, colophon?
+      _tmpdir = tmpdir.nil? ? Dir.mktmpdir : tmpdir
+      epubfile = "#{current}/#{epubfile}" if epubfile !~ /\A\// # /
+      # FIXME: error check
+      File.unlink(epubfile) if File.exist?(epubfile)
+      begin
+        @epub.produce(epubfile, basedir, _tmpdir)
+      ensure
+        FileUtils.rm_r(_tmpdir) if tmpdir.nil?
+      end
+    end
+    private
+    # Complement parameters.
+    def complement
+      # FIXME: should separate for EPUB2/3?
+      # FIXME: escapeHTML?
+      # use default value if not defined
+      @params["htmlext"] = "html" if @params["htmlext"].nil?
+      defaults = {
+        "cover" => "#{@params["bookname"]}.#{@params["htmlext"]}",
+        "title" => @params["booktitle"], # backward compatibility
+        "language" => "ja",
+        "date" => Time.now.strftime("%Y-%m-%d"),
+        "urnid" => "urn:uid:#{UUID.create}",
+        "tocfile" => "toc.#{@params["htmlext"]}",
+        "toclevel" => 2,
+        "stylesheet" => [],
+        "epubversion" => 2,
+        "htmlversion" => 4,
+      }
+      defaults.each_pair do |k, v|
+        @params[k] = v if @params[k].nil?
+      end
+      @params["htmlversion"] == 5 if @params["epubversion"] >= 3 && @params["htmlversion"] == 4
+      # must be defined
+      %w[bookname title].each do |k|
+        raise "Key #{k} must have a value. Abort." if @params[k].nil? # FIXME: should not be error?
+      end
+      # array
+      %w[subject aut a-adp a-ann a-arr a-art a-asn a-aqt a-aft a-aui a-ant a-bkp a-clb a-cmm a-dsr a-edt a-ill a-lyr a-mdc a-mus a-nrt a-oth a-pht a-prt a-red a-rev a-spn a-ths a-trc a-trl adp ann arr art asn aut aqt aft aui ant bkp clb cmm dsr edt ill lyr mdc mus nrt oth pht prt red rev spn ths trc trl stylesheet].each do |item|
+        @params[item] = [@params[item]] if !@params[item].nil? && @params[item].instance_of?(String) # FIXME: avoid double insert
+      end
+      # optional
+      # type, format, identifier, source, relation, coverpage, rights, aut
+    end
+  end
+end