RubyGems - review - Versions diffs - 1.2.0 → 1.3.0 - Mend

review 1.2.0 → 1.3.0

Files changed (78) hide show

checksums.yaml +4 -4
data/.gitignore +36 -0
data/.rubocop.yml +1 -0
data/ChangeLog +102 -0
data/README.rdoc +2 -2
data/bin/review-check +18 -16
data/bin/review-compile +49 -42
data/bin/review-epubmaker +23 -993
data/bin/review-epubmaker-legacy +1024 -0
data/bin/review-index +17 -15
data/bin/review-init +39 -9
data/bin/review-pdfmaker +124 -89
data/bin/review-preproc +16 -14
data/bin/review-vol +17 -15
data/debian/docs +1 -1
data/doc/catalog.rdoc +34 -0
data/doc/format.rdoc +16 -2
data/doc/libepubmaker/{config.yaml → config.yml} +63 -19
data/doc/quickstart.rdoc +1 -1
data/doc/{sample.yaml → sample.yml} +0 -0
data/lib/epubmaker.rb +1 -1
data/lib/epubmaker/content.rb +9 -1
data/lib/epubmaker/epubv2.rb +59 -7
data/lib/epubmaker/epubv3.rb +14 -9
data/lib/epubmaker/producer.rb +68 -27
data/lib/epubmaker/resource.rb +3 -1
data/lib/lineinput.rb +2 -2
data/lib/review/book/base.rb +125 -24
data/lib/review/book/chapter.rb +42 -0
data/lib/review/book/compilable.rb +23 -4
data/lib/review/book/image_finder.rb +64 -0
data/lib/review/book/index.rb +64 -50
data/lib/review/book/page_metric.rb +1 -1
data/lib/review/builder.rb +19 -12
data/lib/review/catalog.rb +47 -0
data/lib/review/compiler.rb +3 -2
data/lib/review/configure.rb +5 -3
data/lib/review/epubmaker.rb +130 -46
data/lib/review/ewbbuilder.rb +27 -31
data/lib/review/extentions/string.rb +4 -4
data/lib/review/htmlbuilder.rb +140 -79
data/lib/review/htmllayout.rb +26 -4
data/lib/review/htmlutils.rb +20 -1
data/lib/review/i18n.rb +5 -2
data/lib/review/{i18n.yaml → i18n.yml} +4 -2
data/lib/review/idgxmlbuilder.rb +65 -39
data/lib/review/latexbuilder.rb +72 -24
data/lib/review/latexutils.rb +3 -1
data/lib/review/makerhelper.rb +8 -2
data/lib/review/preprocessor.rb +20 -20
data/lib/review/review.tex.erb +4 -0
data/lib/review/sec_counter.rb +9 -11
data/lib/review/tocparser.rb +2 -2
data/lib/review/tocprinter.rb +12 -12
data/lib/review/topbuilder.rb +15 -15
data/lib/review/version.rb +1 -1
data/lib/uuid.rb +7 -7
data/review.gemspec +2 -2
data/rubocop-todo.yml +443 -0
data/test/sample-book/src/config.yml +2 -2
data/test/sample-book/src/{main.css → style.css} +0 -0
data/test/test_book.rb +46 -48
data/test/test_book_chapter.rb +25 -13
data/test/test_builder.rb +3 -3
data/test/test_catalog.rb +107 -0
data/test/test_epubmaker.rb +6 -6
data/test/test_htmlbuilder.rb +160 -39
data/test/test_htmlutils.rb +22 -0
data/test/test_i18n.rb +2 -2
data/test/test_idgxmlbuilder.rb +33 -47
data/test/test_image_finder.rb +82 -0
data/test/test_inaobuilder.rb +1 -1
data/test/test_latexbuilder.rb +35 -39
data/test/test_lineinput.rb +2 -2
data/test/test_markdownbuilder.rb +2 -2
data/test/test_topbuilder.rb +39 -23
metadata +23 -14
data/bin/review-epubmaker-ng +0 -23

@@ -1,7 +1,7 @@
 # encoding: utf-8
 # = epubv3.rb -- EPUB version 3 producer.
 #
-# Copyright (c) 2010-2013 Kenshi Muto
+# Copyright (c) 2010-2014 Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -12,7 +12,7 @@
 require 'epubmaker/epubv2'
 module EPUBMaker
   # EPUBv3 is EPUB version 3 producer.
   class EPUBv3 < EPUBv2
     def opf_guide
@@ -124,10 +124,14 @@ EOT
           end
         end
       end
       @producer.contents.each do |item|
         next if item.file =~ /#/ || item.id.nil? # skip subgroup, or id=nil (for cover)
-        s << %Q[    <item#{mathstr} id="#{item.id}" href="#{item.file}" media-type="#{item.media}"/>\n]
+        propstr = ""
+        if item.properties.size > 0
+          propstr = %Q[ properties="#{item.properties.sort.uniq.join(" ")}"]
+        end
+        s << %Q[    <item#{mathstr} id="#{item.id}" href="#{item.file}" media-type="#{item.media}"#{propstr}/>\n]
       end
       s << %Q[  </manifest>\n]
@@ -139,7 +143,7 @@ EOT
       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]
       @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?
@@ -187,7 +191,7 @@ EOT
           end
         end
       end
       s << <<EOT
     <item id="#{@producer.params["bookname"]}" href="#{@producer.params["cover"]}" media-type="application/xhtml+xml"/>
 EOT
@@ -198,16 +202,17 @@ EOT
       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"]}">
+<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/epub" xmlns:ops="http://www.idpf.org/2007/ops" xml:lang="#{@producer.params["language"]}">
 <head>
   <meta charset="UTF-8" />
-  <meta name="generator" content="EPUBMaker::Producer"/>
+  <meta name="generator" content="Re:VIEW" />
 EOT
       @producer.params["stylesheet"].each do |file|
         s << %Q[  <link rel="stylesheet" type="text/css" href="#{file}"/>\n]
       end
       s
     end
   end
 end

data/lib/epubmaker/producer.rb CHANGED

@@ -26,19 +26,19 @@ module EPUBMaker
     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)
       merge_params(@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#merge_params.
     # +version+ takes EPUB version (default is 2).
@@ -47,18 +47,18 @@ module EPUBMaker
       @params = {}
       @epub = nil
       @params["epubversion"] = version unless version.nil?
       unless params.nil?
         merge_params(params)
       end
     end
     # Update parameters by merging from new parameter hash +params+.
     def merge_params(params)
       @params = @params.merge(params)
       complement
       @res = EPUBMaker::Resource.new(@params)
       unless @params["epubversion"].nil?
         case @params["epubversion"].to_i
         when 2
@@ -69,33 +69,34 @@ module EPUBMaker
           raise "Invalid EPUB version (#{@params["epubversion"]}.)"
         end
       end
+      support_legacy_maker
     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.
@@ -103,19 +104,19 @@ module EPUBMaker
       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
@@ -143,34 +144,38 @@ module EPUBMaker
       end
     end
-    alias importImageInfo import_imageinfo
+    alias_method :importImageInfo, :import_imageinfo
     # 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?
       _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
     def call_hook(filename, *params)
       if !filename.nil? && File.exist?(filename) && FileTest.executable?(filename)
-        system(filename, *params)
+        if ENV["REVIEW_SAFE_MODE"].to_i & 1 > 0
+          warn "hook is prohibited in safe mode. ignored."
+        else
+          system(filename, *params)
+        end
       end
     end
     private
     # Complement parameters.
@@ -192,10 +197,10 @@ module EPUBMaker
         "htmlversion" => 4,
         "secnolevel" => 2,
         "pre_secnolevel" => 0,
-        "post_secnolevel" => 0,
+        "post_secnolevel" => 1,
         "part_secnolevel" => 1,
         "titlepage" => nil,
-        "titlepagefile" => nil,
+        "titlefile" => nil,
         "originaltitlefile" => nil,
         "profile" => nil,
         "colophon" => nil,
@@ -212,6 +217,8 @@ module EPUBMaker
         "fontdir" => "fonts",
         "image_ext" => %w(png gif jpg jpeg svg ttf woff otf),
         "font_ext" => %w(ttf woff otf),
+        "verify_target_images" => nil,
+        "force_include_images" => [],
       }
       defaults.each_pair do |k, v|
@@ -219,16 +226,50 @@ module EPUBMaker
       end
       @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?
       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|
+      %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 rights].each do |item|
         @params[item] = [@params[item]] if !@params[item].nil? && @params[item].instance_of?(String)
       end
       # optional
-      # type, format, identifier, source, relation, coverpage, rights, aut
+      # type, format, identifier, source, relation, coverpage, aut
+    end
+    def support_legacy_maker
+      # legacy review-epubmaker support
+      if @params["flag_legacy_coverfile"].nil? && !@params["coverfile"].nil? && File.exist?(@params["coverfile"])
+        @params["cover"] = "#{@params["bookname"]}-cover.#{@params["htmlext"]}"
+        @epub.legacy_cover_and_title_file(@params["coverfile"], @params["cover"])
+        @params["flag_legacy_coverfile"] = true
+        warn "Parameter 'coverfile' is obsolete. Please use 'cover' and make complete html file with header and footer."
+      end
+      if @params["flag_legacy_titlepagefile"].nil? && !@params["titlepagefile"].nil? && File.exist?(@params["titlepagefile"])
+        @params["titlefile"] = "#{@params["bookname"]}-title.#{@params["htmlext"]}"
+        @params["titlepage"] = true
+        @epub.legacy_cover_and_title_file(@params["titlepagefile"], @params["titlefile"])
+        @params["flag_legacy_titlepagefile"] = true
+        warn "Parameter 'titlepagefile' is obsolete. Please use 'titlefile' and make complete html file with header and footer."
+      end
+      if @params["flag_legacy_backcoverfile"].nil? && !@params["backcoverfile"].nil? && File.exist?(@params["backcoverfile"])
+        @params["backcover"] = "#{@params["bookname"]}-backcover.#{@params["htmlext"]}"
+        @epub.legacy_cover_and_title_file(@params["backcoverfile"], @params["backcover"])
+        @params["flag_legacy_backcoverfile"] = true
+        warn "Parameter 'backcoverfile' is obsolete. Please use 'backcover' and make complete html file with header and footer."
+      end
+      if @params["flag_legacy_pubhistory"].nil? && !@params["pubhistory"].nil?
+        @params["history"] = [[]]
+        @params["pubhistory"].split("\n").each do |date|
+          @params["history"][0].push(date.sub(/(\d+)年(\d+)月(\d+)日/, '\1-\2-\3'))
+        end
+        @params["flag_legacy_pubhistory"] = true
+        warn "Parameter 'pubhistory' is obsolete. Please use 'history' array."
+      end
     end
   end
 end

data/lib/epubmaker/resource.rb CHANGED

@@ -1,7 +1,7 @@
 # encoding: utf-8
 # = resource.rb -- Message resources for EPUBMaker.
 #
-# Copyright (c) 2010-2013 Kenshi Muto
+# Copyright (c) 2010-2014 Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -44,6 +44,7 @@ module EPUBMaker
         "colophontitle" => "Colophon",
         "profiletitle" => "Profile",
         "advtitle" => "Advertisement",
+        "backcovertitle" => "Back Cover",
         "c-aut" => "Author",
         "c-csl" => "Consultant",
         "c-dsr" => "Designer",
@@ -66,6 +67,7 @@ module EPUBMaker
         "colophontitle" => "奥付",
         "advtitle" => "広告",
         "profiletitle" => "著者紹介",
+        "backcovertitle" => "裏表紙",
         "c-aut" => "著　者",
         "c-csl" => "監　修",
         "c-dsr" => "デザイン",

data/lib/lineinput.rb CHANGED

@@ -113,7 +113,7 @@ class LineInput
     buf
   end
-  alias span getlines_while   # from Haskell
+  alias_method :span, :getlines_while   # from Haskell
   def until_match(re)
     while line = gets()
@@ -134,7 +134,7 @@ class LineInput
     buf
   end
-  alias break getlines_until   # from Haskell
+  alias_method :break, :getlines_until   # from Haskell
   def until_terminator(re)
     while line = gets()

data/lib/review/book/base.rb CHANGED

@@ -9,23 +9,24 @@
 # the GNU LGPL, Lesser General Public License version 2.1.
 # For details of the GNU LGPL, see the file "COPYING".
 #
+require 'review/configure'
+require 'review/catalog'
 module ReVIEW
   module Book
     class Base
-      attr_accessor :param
+      attr_writer :config
       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
+        basedir = "."
+        if File.file?("#{basedir}/CHAPS") ||
+            File.file?("#{basedir}/catalog.yml")
+          book = load(basedir)
+          book
+        else
+          new(basedir)
         end
-        new('.')
       end
       def self.load(dir)
@@ -37,11 +38,12 @@ module ReVIEW
       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")
+          if ENV["REVIEW_SAFE_MODE"].to_i & 2 > 0
+            warn "review-ext.rb is prohibited in safe mode. ignored."
+          else
+            Kernel.load File.expand_path("#{dir}/review-ext.rb")
+          end
         end
         @basedir_seen[dir] = true
       end
@@ -93,37 +95,113 @@ module ReVIEW
         chapters.each(&block)
       end
+      def each_chapter_r(&block)
+        chapters.reverse.each(&block)
+      end
       def chapter_index
-        @chapter_index ||= ChapterIndex.new(chapters())
-        @chapter_index
+        return @chapter_index if @chapter_index
+        contents = chapters()
+        parts().each do |prt|
+          if prt.id.present?
+            contents << prt
+          end
+        end
+        @chapter_index = ChapterIndex.new(contents)
       end
       def chapter(id)
         chapter_index()[id]
       end
+      def next_chapter(chapter)
+        finded = false
+        each_chapter do |c|
+          return c if finded
+          finded = true if c == chapter
+        end
+        nil # not found
+      end
+      def prev_chapter(chapter)
+        finded = false
+        each_chapter_r do |c|
+          return c if finded
+          finded = true if c == chapter
+        end
+        nil # not found
+      end
       def volume
         Volume.sum(chapters.map {|chap| chap.volume })
       end
+      def config
+        @config ||= Configure.values
+      end
+      # backword compatible
+      def param=(param)
+        @config = param
+      end
+      # backword compatible
+      def param
+        @config
+      end
+      def catalog
+        return @catalog if @catalog.present?
+        catalogfile_path = "#{basedir}/#{config["catalogfile"]}"
+        if File.exist? catalogfile_path
+          @catalog = Catalog.new(File.open catalogfile_path)
+        end
+        @catalog
+      end
       def read_CHAPS
-        read_FILE("chapter_file")
+        if catalog
+          catalog.chaps
+        else
+          read_FILE(chapter_file)
+        end
       end
       def read_PREDEF
-        read_FILE("predef_file")
+        if catalog
+          catalog.predef
+        else
+          read_FILE(predef_file)
+        end
       end
       def read_POSTDEF
-        read_FILE("postdef_file")
+        if catalog
+          catalog.postdef
+        else
+          read_FILE(postdef_file)
+        end
       end
       def read_PART
-        @read_PART ||= File.read("#{@basedir}/#{part_file}")
+        return @read_PART if @read_PART
+        if catalog
+          @read_PART = catalog.parts
+        else
+          @read_PART = File.read("#{@basedir}/#{part_file}")
+        end
       end
       def part_exist?
-        File.exist?("#{@basedir}/#{part_file}")
+        if catalog
+          catalog.parts.present?
+        else
+          File.exist?("#{@basedir}/#{part_file}")
+        end
       end
       def read_bib
@@ -135,6 +213,10 @@ module ReVIEW
       end
       def prefaces
+        if catalog
+          return mkpart_from_namelist(catalog.predef.split("\n"))
+        end
         if File.file?("#{@basedir}/#{predef_file}")
           begin
             return mkpart_from_namelistfile("#{@basedir}/#{predef_file}")
@@ -147,6 +229,10 @@ module ReVIEW
       end
       def postscripts
+        if catalog
+          return mkpart_from_namelist(catalog.postdef.split("\n"))
+        end
         if File.file?("#{@basedir}/#{postdef_file}")
           begin
             return mkpart_from_namelistfile("#{@basedir}/#{postdef_file}")
@@ -178,6 +264,21 @@ module ReVIEW
       def parse_chapters
         part = 0
         num = 0
+        if catalog
+          return catalog.parts_with_chaps.map do |entry|
+            if entry.is_a? Hash
+              chaps = entry.values.first.map do |chap|
+                Chapter.new(self, (num += 1), chap, "#{@basedir}/#{chap}")
+              end
+              Part.new(self, (part += 1), chaps, read_PART.split("\n")[part - 1])
+            else
+              chap = Chapter.new(self, (num += 1), entry, "#{@basedir}/#{entry}")
+              Part.new(self, nil, [chap])
+            end
+          end
+        end
         chap = read_CHAPS()\
           .strip.lines.map {|line| line.strip }.join("\n").split(/\n{2,}/)\
           .map {|part_chunk|
@@ -221,15 +322,15 @@ module ReVIEW
         Chapter.new(self, number, name, path)
       end
-      def mkchap_ifexist(id)
-        name = "#{id}#{ext()}"
+      def mkchap_ifexist(name)
+        name += ext if File.extname(name) == ""
         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|
+        File.open("#{@basedir}/#{filename}") do |f|
           while line = f.gets
             line.sub!(/\A\xEF\xBB\xBF/u, '') # remove BOM
             if /\A#/ =~ line