review 2.0.0.beta1 → 2.0.0

data/lib/review/pdfmaker.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 #
-# Copyright (c) 2010-2015 Kenshi Muto and Masayoshi Takahashi
+# Copyright (c) 2010-2016 Kenshi Muto and Masayoshi Takahashi
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -11,9 +11,17 @@ require 'optparse'
 require 'yaml'
 require 'fileutils'
 require 'erb'
+require 'tmpdir'
 
-require 'review'
 require 'review/i18n'
+require 'review/book'
+require 'review/configure'
+require 'review/converter'
+require 'review/latexbuilder'
+require 'review/yamlloader'
+require 'review/version'
+require 'review/makerhelper'
+require 'review/template'
 
 
 module ReVIEW
@@ -22,8 +30,11 @@ module ReVIEW
     include FileUtils
     include ReVIEW::LaTeXUtils
 
+    attr_accessor :config, :basedir
+
     def initialize
-      @basedir = Dir.pwd
+      @basedir = nil
+      @input_files = Hash.new{|h, key| h[key] = ""}
     end
 
     def system_or_raise(*args)
@@ -39,13 +50,25 @@ module ReVIEW
       $stderr.puts "#{File.basename($0, '.*')}: warning: #{msg}"
     end
 
-    def check_book(config)
-      pdf_file = config["bookname"]+".pdf"
-      File.unlink(pdf_file) if File.exist?(pdf_file)
+    def pdf_filepath
+      File.join(@basedir, @config["bookname"]+".pdf")
+    end
+
+    def remove_old_file
+      FileUtils.rm_f(pdf_filepath)
     end
 
-    def build_path(config)
-      "./#{config["bookname"]}-pdf"
+    def build_path
+      if @config["debug"]
+        path = "#{@config["bookname"]}-pdf"
+        if File.exist?(path)
+          FileUtils.rm_rf(path, :secure => true)
+        end
+        Dir.mkdir(path)
+        return path
+      else
+        return Dir.mktmpdir("#{@config["bookname"]}-pdf-")
+      end
     end
 
     def check_compile_status(ignore_errors)
@@ -89,120 +112,114 @@ module ReVIEW
     end
 
     def execute(*args)
-      config = ReVIEW::Configure.values
+      @config = ReVIEW::Configure.values
+      @config.maker = "pdfmaker"
       cmd_config, yamlfile = parse_opts(args)
-
-      config.merge!(YAML.load_file(yamlfile))
+      loader = ReVIEW::YAMLLoader.new
+      @config.deep_merge!(loader.load_file(yamlfile))
       # YAML configs will be overridden by command line options.
-      config.merge!(cmd_config)
-      I18n.setup(config["language"])
-      generate_pdf(config, yamlfile)
+      @config.merge!(cmd_config)
+      I18n.setup(@config["language"])
+      @basedir = File.dirname(yamlfile)
+
+      begin
+        @config.check_version(ReVIEW::VERSION)
+      rescue ReVIEW::ConfigError => e
+        warn e.message
+      end
+      generate_pdf(yamlfile)
     end
 
-    def generate_pdf(config, yamlfile)
-      check_book(config)
-      @path = build_path(config)
-      bookname = config["bookname"]
-      Dir.mkdir(@path)
-
-      @chaps_fnames = Hash.new{|h, key| h[key] = ""}
-      @compile_errors = nil
-
-      book = ReVIEW::Book.load(@basedir)
-      book.config = config
-      book.parts.each do |part|
-        if part.name.present?
-          if part.file?
-            output_chaps(part.name, config, yamlfile)
-            @chaps_fnames["CHAPS"] << %Q|\\input{#{part.name}.tex}\n|
-          else
-            @chaps_fnames["CHAPS"] << %Q|\\part{#{part.name}}\n|
+    def generate_pdf(yamlfile)
+      remove_old_file
+      @path = build_path()
+      begin
+        @compile_errors = nil
+
+        book = ReVIEW::Book.load(@basedir)
+        book.config = @config
+        @converter = ReVIEW::Converter.new(book, ReVIEW::LATEXBuilder.new)
+        book.parts.each do |part|
+          if part.name.present?
+            if part.file?
+              output_chaps(part.name, yamlfile)
+              @input_files["CHAPS"] << %Q|\\input{#{part.name}.tex}\n|
+            else
+              @input_files["CHAPS"] << %Q|\\part{#{part.name}}\n|
+            end
           end
-        end
 
-        part.chapters.each do |chap|
-          filename = File.basename(chap.path, ".*")
-          output_chaps(filename, config, yamlfile)
-          @chaps_fnames["PREDEF"]  << "\\input{#{filename}.tex}\n" if chap.on_PREDEF?
-          @chaps_fnames["CHAPS"]   << "\\input{#{filename}.tex}\n" if chap.on_CHAPS?
-          @chaps_fnames["APPENDIX"] << "\\input{#{filename}.tex}\n" if chap.on_APPENDIX?
-          @chaps_fnames["POSTDEF"] << "\\input{#{filename}.tex}\n" if chap.on_POSTDEF?
+          part.chapters.each do |chap|
+            filename = File.basename(chap.path, ".*")
+            output_chaps(filename, yamlfile)
+            @input_files["PREDEF"] << "\\input{#{filename}.tex}\n" if chap.on_PREDEF?
+            @input_files["CHAPS"] << "\\input{#{filename}.tex}\n" if chap.on_CHAPS?
+            @input_files["APPENDIX"] << "\\input{#{filename}.tex}\n" if chap.on_APPENDIX?
+            @input_files["POSTDEF"] << "\\input{#{filename}.tex}\n" if chap.on_POSTDEF?
+          end
         end
-      end
-
-      check_compile_status(config["ignore-errors"])
 
-      config["pre_str"]  = @chaps_fnames["PREDEF"]
-      config["chap_str"] = @chaps_fnames["CHAPS"]
-      config["appendix_str"] = @chaps_fnames["APPENDIX"]
-      config["post_str"] = @chaps_fnames["POSTDEF"]
+        check_compile_status(@config["ignore-errors"])
 
-      config["usepackage"] = ""
-      if config["texstyle"]
-        config["usepackage"] = "\\usepackage{#{config['texstyle']}}"
-      end
+        @config["usepackage"] = ""
+        if @config["texstyle"]
+          @config["usepackage"] = "\\usepackage{#{@config['texstyle']}}"
+        end
 
-      copy_images("./images", "#{@path}/images")
-      copyStyToDir(Dir.pwd + "/sty", @path)
-      copyStyToDir(Dir.pwd + "/sty", @path, "fd")
-      copyStyToDir(Dir.pwd + "/sty", @path, "cls")
-      copyStyToDir(Dir.pwd, @path, "tex")
+        copy_images("./images", File.join(@path, "images"))
+        copyStyToDir(File.join(Dir.pwd, "sty"), @path)
+        copyStyToDir(File.join(Dir.pwd, "sty"), @path, "fd")
+        copyStyToDir(File.join(Dir.pwd, "sty"), @path, "cls")
+        copyStyToDir(Dir.pwd, @path, "tex")
 
-      Dir.chdir(@path) {
-        template = get_template(config)
-        File.open("./book.tex", "wb"){|f| f.write(template)}
+        template = get_template
+        Dir.chdir(@path) do
+          File.open("./book.tex", "wb"){|f| f.write(template)}
 
-        call_hook("hook_beforetexcompile", config)
+          call_hook("hook_beforetexcompile")
 
-        ## do compile
-        enc = config["params"].to_s.split(/\s+/).find{|i| i =~ /\A--outencoding=/ }
-        kanji = 'utf8'
-        texcommand = "platex"
-        texoptions = "-kanji=#{kanji}"
-        dvicommand = "dvipdfmx"
-        dvioptions = "-d 5"
+          ## do compile
+          if ENV["REVIEW_SAFE_MODE"].to_i & 4 > 0
+            warn "command configuration is prohibited in safe mode. ignored."
+          else
+            texcommand = @config["texcommand"] if @config["texcommand"]
+            dvicommand = @config["dvicommand"] if @config["dvicommand"]
+            dvioptions = @config["dvioptions"] if @config["dvioptions"]
+            texoptions = @config["texoptions"] if @config["texoptions"]
+          end
+          3.times do
+            system_or_raise("#{texcommand} #{texoptions} book.tex")
+          end
+          call_hook("hook_aftertexcompile")
 
-        if ENV["REVIEW_SAFE_MODE"].to_i & 4 > 0
-          warn "command configuration is prohibited in safe mode. ignored."
-        else
-          texcommand = config["texcommand"] if config["texcommand"]
-          dvicommand = config["dvicommand"] if config["dvicommand"]
-          dvioptions = config["dvioptions"] if config["dvioptions"]
-          if enc
-            kanji = enc.split(/\=/).last.gsub(/-/, '').downcase
-            texoptions = "-kanji=#{kanji}"
+          if File.exist?("book.dvi")
+            system_or_raise("#{dvicommand} #{dvioptions} book.dvi")
           end
-          texoptions = config["texoptions"] if config["texoptions"]
         end
-        3.times do
-          system_or_raise("#{texcommand} #{texoptions} book.tex")
-        end
-        call_hook("hook_aftertexcompile", config)
+        call_hook("hook_afterdvipdf")
 
-      if File.exist?("book.dvi")
-          system_or_raise("#{dvicommand} #{dvioptions} book.dvi")
-        end
-      }
-      call_hook("hook_afterdvipdf", config)
-      
-      FileUtils.cp("#{@path}/book.pdf", "#{@basedir}/#{bookname}.pdf")
+        FileUtils.cp(File.join(@path, "book.pdf"), pdf_filepath)
 
-      unless config["debug"]
-        remove_entry_secure @path
+      ensure
+        unless @config["debug"]
+          remove_entry_secure @path
+        end
       end
     end
 
-    def output_chaps(filename, config, yamlfile)
+    def output_chaps(filename, yamlfile)
       $stderr.puts "compiling #{filename}.tex"
-      cmd = "#{ReVIEW::MakerHelper.bindir}/review-compile --yaml=#{yamlfile} --target=latex --level=#{config["secnolevel"]} --toclevel=#{config["toclevel"]} #{config["params"]} #{filename}.re > #{@path}/#{filename}.tex"
-      if system cmd
-        # OK
-      else
+      begin
+        @converter.convert(filename+".re", File.join(@path, filename+".tex"))
+      rescue => e
         @compile_errors = true
-        warn cmd
+        warn "compile error in #{filename}.tex (#{e.class})"
+        warn e.message
       end
     end
 
+    # PDFMaker#copy_images should copy image files _AND_ execute extractbb (or ebb).
+    #
     def copy_images(from, to)
       if File.exist?(from)
         Dir.mkdir(to)
@@ -237,89 +254,131 @@ module ReVIEW
       end
     end
 
-    def make_colophon_role(role, config)
-      if config[role].present?
-        return "#{ReVIEW::I18n.t(role)} & #{escape_latex(join_with_separator(config[role], ReVIEW::I18n.t("names_splitter")))} \\\\\n"
+    def make_colophon_role(role)
+      if @config[role].present?
+        initialize_metachars(@config["texcommand"])
+        return "#{ReVIEW::I18n.t(role)} & #{escape_latex(join_with_separator(@config.names_of(role), ReVIEW::I18n.t("names_splitter")))} \\\\\n"
       else
         ""
       end
     end
 
-    def make_colophon(config)
+    def make_colophon
       colophon = ""
-      config["colophon_order"].each do |role|
-        colophon += make_colophon_role(role, config)
+      @config["colophon_order"].each do |role|
+        colophon += make_colophon_role(role)
       end
       colophon
     end
 
-    def make_authors(config)
+    def make_authors
       authors = ""
-      if config["aut"].present?
-        author_names = join_with_separator(config["aut"], ReVIEW::I18n.t("names_splitter"))
+      if @config["aut"].present?
+        author_names = join_with_separator(@config.names_of("aut"), ReVIEW::I18n.t("names_splitter"))
         authors = ReVIEW::I18n.t("author_with_label", author_names)
       end
-      if config["csl"].present?
-        csl_names = join_with_separator(config["csl"], ReVIEW::I18n.t("names_splitter"))
+      if @config["csl"].present?
+        csl_names = join_with_separator(@config.names_of("csl"), ReVIEW::I18n.t("names_splitter"))
         authors += " \\\\\n"+ ReVIEW::I18n.t("supervisor_with_label", csl_names)
       end
-      if config["trl"].present?
-        trl_names = join_with_separator(config["trl"], ReVIEW::I18n.t("names_splitter"))
+      if @config["trl"].present?
+        trl_names = join_with_separator(@config.names_of("trl"), ReVIEW::I18n.t("names_splitter"))
         authors += " \\\\\n"+ ReVIEW::I18n.t("translator_with_label", trl_names)
       end
       authors
     end
 
-    def get_template(config)
-      dclass = config["texdocumentclass"] || []
-      documentclass =  dclass[0] || "jsbook"
-      documentclassoption =  dclass[1] || "oneside"
+    def make_history_list
+      buf = []
+      if @config["history"]
+        @config["history"].each_with_index do |items, edit|
+          items.each_with_index do |item, rev|
+            editstr = (edit == 0) ? ReVIEW::I18n.t("first_edition") : ReVIEW::I18n.t("nth_edition","#{edit+1}")
+            revstr = ReVIEW::I18n.t("nth_impression", "#{rev+1}")
+            if item =~ /\A\d+\-\d+\-\d+\Z/
+              buf << ReVIEW::I18n.t("published_by1", [date_to_s(item), editstr+revstr])
+            else
+              # custom date with string
+              item.match(/\A(\d+\-\d+\-\d+)[\s　](.+)/) do |m|
+                buf << ReVIEW::I18n.t("published_by3", [date_to_s(m[1]), m[2]])
+              end
+            end
+          end
+        end
+      elsif @config["date"]
+        buf << ReVIEW::I18n.t("published_by2",
+                              date_to_s(@config["date"]))
+      end
+      buf
+    end
+
+    def date_to_s(date)
+      require 'date'
+      d = Date.parse(date)
+      d.strftime(ReVIEW::I18n.t("date_format"))
+    end
 
-      okuduke = make_colophon(config)
-      authors = make_authors(config)
+    def get_template
+      dclass = @config["texdocumentclass"] || []
+      @documentclass = dclass[0] || "jsbook"
+      @documentclassoption = dclass[1] || "uplatex,oneside"
 
-      custom_titlepage = make_custom_page(config["coverfile"])
-      custom_originaltitlepage = make_custom_page(config["originaltitlefile"])
-      custom_creditpage = make_custom_page(config["creditfile"])
+      @okuduke = make_colophon
+      @authors = make_authors
 
-      custom_profilepage = make_custom_page(config["profile"])
-      custom_advfilepage = make_custom_page(config["advfile"])
-      if config["colophon"] && config["colophon"].kind_of?(String)
-        custom_colophonpage = make_custom_page(config["colophon"])
+      @custom_titlepage = make_custom_page(@config["cover"]) || make_custom_page(@config["coverfile"])
+      @custom_originaltitlepage = make_custom_page(@config["originaltitlefile"])
+      @custom_creditpage = make_custom_page(@config["creditfile"])
+
+      @custom_profilepage = make_custom_page(@config["profile"])
+      @custom_advfilepage = make_custom_page(@config["advfile"])
+      if @config["colophon"] && @config["colophon"].kind_of?(String)
+        @custom_colophonpage = make_custom_page(@config["colophon"])
       end
-      custom_backcoverpage = make_custom_page(config["backcover"])
+      @custom_backcoverpage = make_custom_page(@config["backcover"])
 
-      template = File.expand_path('layout.tex.erb', File.dirname(__FILE__))
+      if @config["pubhistory"]
+        warn "pubhistory is oboleted. use history."
+      else
+        @config["pubhistory"] = make_history_list.join("\n")
+      end
+      if @documentclass == "ubook" || @documentclass == "utbook"
+        @coverimageoption = "width=\\textheight,height=\\textwidth,keepaspectratio,angle=90"
+      else
+        @coverimageoption = "width=\\textwidth,height=\\textheight,keepaspectratio"
+      end
+
+      template = File.expand_path('./latex/layout.tex.erb', ReVIEW::Template::TEMPLATE_DIR)
       layout_file = File.join(@basedir, "layouts", "layout.tex.erb")
       if File.exist?(layout_file)
         template = layout_file
       end
 
-      erb = ERB.new(File.open(template).read)
-      values = config # must be 'values' for legacy files
+      @texcompiler = File.basename(@config["texcommand"], ".*")
+
+      erb = ReVIEW::Template.load(template, '-')
       erb.result(binding)
     end
 
     def copyStyToDir(dirname, copybase, extname = "sty")
       unless File.directory?(dirname)
-        $stderr.puts "No such directory - #{dirname}"
+        warn "No such directory - #{dirname}"
         return
       end
 
-      Dir.open(dirname) {|dir|
-        dir.each {|fname|
-          next if fname =~ /^\./
-          if fname =~ /\.(#{extname})$/i
-            Dir.mkdir(copybase) unless File.exist?(copybase)
-            FileUtils.cp "#{dirname}/#{fname}", copybase
+      Dir.open(dirname) do |dir|
+        dir.each do |fname|
+          if File.extname(fname).downcase == "."+extname
+            FileUtils.mkdir_p(copybase)
+            FileUtils.cp File.join(dirname, fname), copybase
           end
-        }
-      }
+        end
+      end
     end
 
-    def call_hook(hookname, config)
-      if config["pdfmaker"].instance_of?(Hash) && config["pdfmaker"][hookname]
-        hook = File.absolute_path(config["pdfmaker"][hookname], @basedir)
+    def call_hook(hookname)
+      if @config["pdfmaker"].instance_of?(Hash) && @config["pdfmaker"][hookname]
+        hook = File.absolute_path(@config["pdfmaker"][hookname], @basedir)
         if ENV["REVIEW_SAFE_MODE"].to_i & 1 > 0
           warn "hook configuration is prohibited in safe mode. ignored."
         else

data/lib/review/preprocessor.rb

@@ -24,24 +24,10 @@ module ReVIEW
     end
 
     def warn(msg)
-      if @config["outencoding"] =~ /^EUC$/
-        msg = NKF.nkf("-W -e", msg)
-      elsif @config["outencoding"] =~ /^SJIS$/
-        msg = NKF.nkf("-W -s", msg)
-      elsif @config["outencoding"] =~ /^JIS$/
-        msg = NKF.nkf("-W -j", msg)
-      end
       $stderr.puts "#{location()}: warning: #{msg}"
     end
 
     def error(msg)
-      if @config["outencoding"] =~ /^EUC$/
-        msg = NKF.nkf("-W -e", msg)
-      elsif @config["outencoding"] =~ /^SJIS$/
-        msg = NKF.nkf("-W -s", msg)
-      elsif @config["outencoding"] =~ /^JIS$/
-        msg = NKF.nkf("-W -j", msg)
-      end
       @errutils_err = true
       raise ApplicationError, "#{location()}: #{msg}"
     end
@@ -148,7 +134,7 @@ module ReVIEW
           path = expand(direc.arg)
           ent = @repository.fetch_file(path)
           ent = evaluate(path, ent) if direc['eval']
-          replace_block f, line, ent, false   # FIXME: turn off lineno: tmp
+          replace_block(f, line, ent, false) # FIXME: turn off lineno: tmp
 
         when /\A\#@map(?:range)?/
           direc = parse_directive(line, 2, 'unindent')
@@ -156,7 +142,7 @@ module ReVIEW
           ent = @repository.fetch_range(path, direc.args[1]) or
                   error "unknown range: #{path}: #{direc.args[1]}"
           ent = (direc['unindent'] ? unindent(ent, direc['unindent']) : ent)
-          replace_block f, line, ent, false   # FIXME: turn off lineno: tmp
+          replace_block(f, line, ent, false) # FIXME: turn off lineno: tmp
 
         when /\A\#@end/
           error 'unbaranced #@end'
@@ -167,7 +153,7 @@ module ReVIEW
           warn "unkown directive: #{line.strip}" unless known_directive?(op)
           @f.print line
 
-        when /\A\s*\z/   # empty line
+        when /\A\s*\z/ # empty line
           @f.puts
         else
           @f.print line
@@ -175,42 +161,17 @@ module ReVIEW
       end
     end
 
-    private
-
     KNOWN_DIRECTIVES = %w( require provide warn ok )
 
     def known_directive?(op)
       KNOWN_DIRECTIVES.index(op)
     end
 
-    def convert_outencoding(*s)
-      ine = ""
-      if @config["inencoding"] =~ /^EUC$/i
-        ine = "-E,"
-      elsif @config["inencoding"] =~ /^SJIS$/i
-        ine = "-S,"
-      elsif @config["inencoding"] =~ /^JIS$/i
-        ine = "-J,"
-      elsif @config["inencoding"] =~ /^UTF\-8$/i
-        ine = "-W,"
-      end
-
-      if @config["outencoding"] =~ /^EUC$/i
-        NKF.nkf("#{ine} -m0x -e", *s)
-      elsif @config["outencoding"] =~ /^SJIS$/i
-        NKF.nkf("#{ine} -m0x -s", *s)
-      elsif @config["outencoding"] =~ /^JIS$/i
-        NKF.nkf("#{ine} -m0x -j", *s)
-      else
-        NKF.nkf("#{ine} -m0x -w", *s)
-      end
-    end
-
     def replace_block(f, directive_line, newlines, with_lineno)
       @f.print directive_line
       newlines.each do |line|
         print_number line.number if with_lineno
-        @f.print convert_outencoding(line.string)
+        @f.print line.string
       end
       skip_list f
     end
@@ -243,8 +204,8 @@ module ReVIEW
     class Directive
       def initialize(op, args, opts)
         @op = op
-	@args = args
-	@opts = opts
+        @args = args
+        @opts = opts
       end
 
       attr_reader :op
@@ -297,12 +258,12 @@ module ReVIEW
 
     def optarg_value(spec)
       case spec
-      when 'true'  then true      # [name=true]
-      when 'false' then false     # [name=false]
-      when 'nil'   then nil       # [name=nil]
-      when nil     then true      # [name]
-      when /^\d+$/ then $&.to_i   # [name=8]
-      else                        # [name=val]
+      when 'true' then true # [name=true]
+      when 'false' then false # [name=false]
+      when 'nil' then nil # [name=nil]
+      when nil then true # [name]
+      when /^\d+$/ then $&.to_i # [name=8]
+      else # [name=val]
         spec
       end
     end
@@ -335,18 +296,6 @@ module ReVIEW
       n == INF_INDENT ? 0 : n
     end
 
-    def check_ruby_syntax(rbfile)
-      status = spawn {
-        exec("ruby -c #{rbfile} 2>&1 > /dev/null")
-      }
-      error "syntax check failed: #{rbfile}" unless status.exitstatus == 0
-    end
-
-    def spawn
-      pid, status = *Process.waitpid2(fork { yield })
-      status
-    end
-
     def evaluate(path, chunk)
       outputs = get_output("ruby #{path}", false).split(/\n/).map {|s| s.strip }
       chunk.map {|line|
@@ -443,7 +392,7 @@ module ReVIEW
     end
 
     def git?(fname)
-      fname =~ /\Agit\|/
+      fname.start_with?('git|')
     end
 
     def parse_git_blob(g_obj)
@@ -454,7 +403,7 @@ module ReVIEW
     end
 
     def parse_file(fname)
-      File.open(fname) {|f|
+      File.open(fname, 'r:BOM|utf-8') {|f|
         init_ErrorUtils f
         return _parse_file(f)
       }
@@ -465,7 +414,7 @@ module ReVIEW
       repo = {'file' => whole}
       curr = {'WHOLE' => whole}
       lineno = 1
-      yacchack = false   # remove ';'-only lines.
+      yacchack = false # remove ';'-only lines.
       opened = [['(not opened)', '(not opened)']] * 3
 
       f.each do |line|
@@ -510,7 +459,7 @@ module ReVIEW
         when /(?:\A\#@|\#@@)yacchack/
           yacchack = true
 
-        when /\A\#@-/   # does not increment line number.
+        when /\A\#@-/ # does not increment line number.
           line = canonical($')
           curr.each_value do |list|
             list.push Line.new(nil, line)