review 5.0.0 → 5.1.0

data/lib/review/makerhelper.rb

@@ -8,7 +8,6 @@
 require 'pathname'
 require 'fileutils'
 require 'yaml'
-require 'shellwords'
 
 begin
   require 'cgi/escape'
@@ -18,12 +17,6 @@ end
 
 module ReVIEW
   module MakerHelper
-    # Return review/bin directory
-    def bindir
-      Pathname.new("#{Pathname.new(__FILE__).realpath.dirname}/../../bin").realpath
-    end
-    module_function :bindir
-
     def h(str)
       CGI.escapeHTML(str)
     end
@@ -51,6 +44,7 @@ module ReVIEW
       Dir.open(from_dir) do |dir|
         dir.each do |fname|
           next if fname =~ /^\./
+
           if FileTest.directory?("#{from_dir}/#{fname}")
             image_files += copy_images_to_dir("#{from_dir}/#{fname}", "#{to_dir}/#{fname}", options)
           else
@@ -59,6 +53,7 @@ module ReVIEW
             is_converted = false
             (options[:convert] || {}).each do |orig_type, conv_type|
               next unless /\.#{orig_type}$/ =~ fname
+
               is_converted = system("convert #{from_dir}/#{fname} #{to_dir}/#{fname}.#{conv_type}")
               image_files << "#{from_dir}/#{fname}.#{conv_type}"
             end
@@ -76,203 +71,5 @@ module ReVIEW
       image_files
     end
     module_function :copy_images_to_dir
-
-    def cleanup_mathimg(path = '_review_math')
-      math_dir = "./#{@config['imagedir']}/#{path}"
-      if @config['imgmath'] && Dir.exist?(math_dir)
-        FileUtils.rm_rf(math_dir)
-      end
-    end
-
-    def default_imgmath_preamble
-      <<-EOB
-\\documentclass[uplatex,a3paper,landscape]{jsarticle}
-\\usepackage[deluxe,uplatex]{otf}
-\\usepackage[T1]{fontenc}
-\\usepackage{textcomp}
-\\usepackage{lmodern}
-\\usepackage[dvipdfmx]{graphicx}
-\\usepackage[dvipdfmx,table]{xcolor}
-\\usepackage[utf8]{inputenc}
-\\usepackage{ascmac}
-\\usepackage{float}
-\\usepackage{alltt}
-\\usepackage{amsmath}
-\\usepackage{amssymb}
-\\usepackage{amsfonts}
-\\usepackage{anyfontsize}
-\\usepackage{bm}
-\\pagestyle{empty}
-% \\setpaperwidth{1000mm}
-    EOB
-    end
-
-    def make_math_images(math_dir)
-      fontsize = @config['imgmath_options']['fontsize'].to_f
-      lineheight = @config['imgmath_options']['lineheight'].to_f
-
-      texsrc = default_imgmath_preamble
-      if @config['imgmath_options']['preamble_file'] && File.readable?(@config['imgmath_options']['preamble_file'])
-        texsrc = File.read(@config['imgmath_options']['preamble_file'])
-      end
-
-      texsrc << <<-EOB
-\\begin{document}
-\\fontsize{#{fontsize}}{#{lineheight}}\\selectfont
-\\input{__IMGMATH_BODY__}
-\\end{document}
-EOB
-
-      hashes = File.readlines(File.join(math_dir, '__IMGMATH_BODY__.map')).sort.uniq
-      File.write(File.join(math_dir, '__IMGMATH_BODY__.map'), hashes.join)
-
-      File.open(File.join(math_dir, '__IMGMATH_BODY__.tex'), 'w') do |f|
-        File.open(File.join(math_dir, '__IMGMATH_BODY__.map')) do |map|
-          map.each_line do |l|
-            l.chomp!
-            f.puts "% #{l}"
-            f.puts File.read(File.join(math_dir, "__IMGMATH_BODY__#{l}.tex"))
-            File.unlink(File.join(math_dir, "__IMGMATH_BODY__#{l}.tex"))
-            f.puts '\\clearpage'
-            f.puts
-          end
-        end
-      end
-
-      math_dir = File.realpath(math_dir)
-      Dir.mktmpdir do |tmpdir|
-        FileUtils.cp([File.join(math_dir, '__IMGMATH_BODY__.tex'),
-                      File.join(math_dir, '__IMGMATH_BODY__.map')],
-                     tmpdir)
-        tex_path = File.join(tmpdir, '__IMGMATH__.tex')
-        File.write(tex_path, texsrc)
-
-        begin
-          case @config['imgmath_options']['converter']
-          when 'pdfcrop'
-            make_math_images_pdfcrop(tmpdir, tex_path, math_dir)
-          when 'dvipng'
-            make_math_images_dvipng(tmpdir, tex_path, math_dir)
-          else
-            error "unknown math converter error. imgmath_options/converter parameter should be 'pdfcrop' or 'dvipng'."
-          end
-        rescue CompileError
-          FileUtils.cp([tex_path,
-                        File.join(File.dirname(tex_path), '__IMGMATH__.log')],
-                       math_dir)
-          error "LaTeX math compile error. See #{math_dir}/__IMGMATH__.log for details."
-        end
-      end
-      FileUtils.rm_f([File.join(math_dir, '__IMGMATH_BODY__.tex'),
-                      File.join(math_dir, '__IMGMATH_BODY__.map')])
-    end
-    module_function :make_math_images
-
-    def make_math_images_pdfcrop(dir, tex_path, math_dir)
-      # rubocop:disable Metrics/BlockLength
-      Dir.chdir(dir) do
-        dvi_path = '__IMGMATH__.dvi'
-        pdf_path = '__IMGMATH__.pdf'
-        out, status = Open3.capture2e(*[@config['texcommand'], @config['texoptions'].shellsplit, tex_path].flatten.compact)
-        if !status.success? || (!File.exist?(dvi_path) && !File.exist?(pdf_path))
-          raise CompileError
-        end
-        if File.exist?(dvi_path)
-          out, status = Open3.capture2e(*[@config['dvicommand'], @config['dvioptions'].shellsplit, dvi_path].flatten.compact)
-          if !status.success? || !File.exist?(pdf_path)
-            warn "error in #{@config['dvicommand']}. Error log:\n#{out}"
-            raise CompileError
-          end
-        end
-        args = @config['imgmath_options']['pdfcrop_cmd'].shellsplit
-        args.map! do |m|
-          m.sub('%i', pdf_path).
-            sub('%o', '__IMGMATH__pdfcrop.pdf')
-        end
-        out, status = Open3.capture2e(*args)
-        unless status.success?
-          warn "error in pdfcrop. Error log:\n#{out}"
-          raise CompileError
-        end
-        pdf_path = '__IMGMATH__pdfcrop.pdf'
-        pdf_path2 = pdf_path
-
-        File.open('__IMGMATH_BODY__.map') do |f|
-          page = 0
-          f.each_line do |key|
-            page += 1
-            key.chomp!
-            if File.exist?(File.join(math_dir, "_gen_#{key}.#{@config['imgmath_options']['format']}"))
-              # made already
-              next
-            end
-
-            if @config['imgmath_options']['extract_singlepage']
-              # if extract_singlepage = true, split each page
-              args = @config['imgmath_options']['pdfextract_cmd'].shellsplit
-
-              args.map! do |m|
-                m.sub('%i', pdf_path).
-                  sub('%o', "__IMGMATH__pdfcrop_p#{page}.pdf").
-                  sub('%O', "__IMGMATH__pdfcrop_p#{page}").
-                  sub('%p', page.to_s)
-              end
-              out, status = Open3.capture2e(*args)
-              unless status.success?
-                warn "error in pdf extracting. Error log:\n#{out}"
-                raise CompileError
-              end
-
-              pdf_path2 = "__IMGMATH__pdfcrop_p#{page}.pdf"
-            end
-
-            args = @config['imgmath_options']['pdfcrop_pixelize_cmd'].shellsplit
-            args.map! do |m|
-              m.sub('%i', pdf_path2).
-                sub('%t', @config['imgmath_options']['format']).
-                sub('%o', File.join(math_dir, "_gen_#{key}.#{@config['imgmath_options']['format']}")).
-                sub('%O', File.join(math_dir, "_gen_#{key}")).
-                sub('%p', page.to_s)
-            end
-            out, status = Open3.capture2e(*args)
-            unless status.success?
-              warn "error in pdf pixelizing. Error log:\n#{out}"
-              raise CompileError
-            end
-          end
-        end
-      end
-      # rubocop:enable Metrics/BlockLength
-    end
-
-    def make_math_images_dvipng(dir, tex_path, math_dir)
-      Dir.chdir(dir) do
-        dvi_path = '__IMGMATH__.dvi'
-        out, status = Open3.capture2e(*[@config['texcommand'], @config['texoptions'].shellsplit, tex_path].flatten.compact)
-        if !status.success? || !File.exist?(dvi_path)
-          raise CompileError
-        end
-
-        File.open('__IMGMATH_BODY__.map') do |f|
-          page = 0
-          f.each_line do |key|
-            page += 1
-            key.chomp!
-            args = @config['imgmath_options']['dvipng_cmd'].shellsplit
-            args.map! do |m|
-              m.sub('%i', dvi_path).
-                sub('%o', File.join(math_dir, "_gen_#{key}.#{@config['imgmath_options']['format']}")).
-                sub('%O', File.join(math_dir, "_gen_#{key}")).
-                sub('%p', page.to_s)
-            end
-            out, status = Open3.capture2e(*args)
-            unless status.success?
-              warn "error in dvipng. Error log:\n#{out}"
-              raise CompileError
-            end
-          end
-        end
-      end
-    end
   end
 end

data/lib/review/markdownbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2019 KADO Masanori, Masayoshi Takahashi, Kenshi Muto
+# Copyright (c) 2013-2020 KADO Masanori, Masayoshi Takahashi, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -224,6 +224,14 @@ module ReVIEW
       "<u>#{str}</u>"
     end
 
+    def inline_ins(str)
+      "<ins>#{str}</ins>"
+    end
+
+    def inline_del(str)
+      "~~#{str}~~"
+    end
+
     def image_image(id, caption, _metric)
       blank
       puts "![#{compile_inline(caption)}](#{@chapter.image(id).path.sub(%r{\A\./}, '')})"
@@ -244,6 +252,28 @@ module ReVIEW
       "<!-- DTP:#{str} -->"
     end
 
+    def inline_hd_chap(chap, id)
+      n = chap.headline_index.number(id)
+      if n.present? && chap.number && over_secnolevel?(n)
+        str = I18n.t('hd_quote', [n, compile_inline(chap.headline(id).caption)])
+      else
+        str = I18n.t('hd_quote_without_number', compile_inline(chap.headline(id).caption))
+      end
+      if @book.config['chapterlink']
+        if @chapter == chap
+          anchor = 'h' + n.tr('.', '-')
+          %Q(<a href="##{anchor}">#{str}</a>)
+        else
+          warn 'MARKDOWNBuilder does not support links to other chapters'
+          str
+        end
+      else
+        str
+      end
+    rescue KeyError
+      error "unknown headline: #{id}"
+    end
+
     def indepimage(_lines, id, caption = '', _metric = nil)
       blank
       puts "![#{compile_inline(caption)}](#{@chapter.image(id).path.sub(%r{\A\./}, '')})"
@@ -358,6 +388,7 @@ module ReVIEW
 
     def comment(lines, comment = nil)
       return unless @book.config['draft']
+
       lines ||= []
       unless comment.blank?
         lines.unshift(comment)

data/lib/review/pdfmaker.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2020 Kenshi Muto and Masayoshi Takahashi
+# Copyright (c) 2010-2021 Kenshi Muto and Masayoshi Takahashi
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -22,11 +22,14 @@ require 'review/yamlloader'
 require 'review/version'
 require 'review/makerhelper'
 require 'review/template'
+require 'review/latexbox'
+require 'review/call_hook'
 
 module ReVIEW
   class PDFMaker
     include FileUtils
     include ReVIEW::LaTeXUtils
+    include ReVIEW::CallHook
 
     attr_accessor :config, :basedir
 
@@ -151,6 +154,7 @@ module ReVIEW
         generate_pdf
       rescue ApplicationError => e
         raise if @config['debug']
+
         error(e.message)
       end
     end
@@ -198,7 +202,7 @@ module ReVIEW
       Dir.chdir(@path) do
         File.open("./#{@mastertex}.tex", 'wb') { |f| f.write template }
 
-        call_hook('hook_beforetexcompile')
+        call_hook('hook_beforetexcompile', Dir.pwd, @basedir, base_dir: @basedir)
 
         ## do compile
         if ENV['REVIEW_SAFE_MODE'].to_i & 4 > 0
@@ -241,32 +245,32 @@ module ReVIEW
           system_or_raise(*[texcommand, texoptions, "#{@mastertex}.tex"].flatten.compact)
         end
 
-        call_hook('hook_beforemakeindex')
+        call_hook('hook_beforemakeindex', Dir.pwd, @basedir, base_dir: @basedir)
         if @config['pdfmaker']['makeindex'] && File.size?("#{@mastertex}.idx")
           system_or_raise(*[makeindex_command, makeindex_options, @mastertex].flatten.compact)
+          call_hook('hook_aftermakeindex', Dir.pwd, @basedir, base_dir: @basedir)
           system_or_raise(*[texcommand, texoptions, "#{@mastertex}.tex"].flatten.compact)
         end
-        call_hook('hook_aftermakeindex')
 
         system_or_raise(*[texcommand, texoptions, "#{@mastertex}.tex"].flatten.compact)
-        call_hook('hook_aftertexcompile')
+        call_hook('hook_aftertexcompile', Dir.pwd, @basedir, base_dir: @basedir)
 
         if File.exist?("#{@mastertex}.dvi") && dvicommand.present?
           system_or_raise(*[dvicommand, dvioptions, "#{@mastertex}.dvi"].flatten.compact)
-          call_hook('hook_afterdvipdf')
+          call_hook('hook_afterdvipdf', Dir.pwd, @basedir, base_dir: @basedir)
         end
       end
     end
 
     def generate_pdf
       remove_old_file
-      erb_config
       @path = build_path
       begin
         @compile_errors = nil
 
         book = ReVIEW::Book::Base.new(@basedir, config: @config)
         @converter = ReVIEW::Converter.new(book, ReVIEW::LATEXBuilder.new)
+        erb_config
 
         @input_files = make_input_files(book)
 
@@ -287,6 +291,7 @@ module ReVIEW
         build_pdf
 
         FileUtils.cp(File.join(@path, "#{@mastertex}.pdf"), pdf_filepath)
+        @logger.success("built #{File.basename(pdf_filepath)}")
       ensure
         remove_entry_secure(@path) unless @config['debug']
       end
@@ -307,6 +312,7 @@ module ReVIEW
     #
     def copy_images(from, to)
       return unless File.exist?(from)
+
       Dir.mkdir(to)
       ReVIEW::MakerHelper.copy_images_to_dir(from, to)
     end
@@ -316,6 +322,7 @@ module ReVIEW
       if File.exist?(file_sty)
         return File.read(file_sty)
       end
+
       nil
     end
 
@@ -445,36 +452,40 @@ module ReVIEW
       @locale_latex['postchaptername'] = chapter_tuple[1].to_s
       @locale_latex['preappendixname'] = appendix_tuple[0].to_s
       @locale_latex['postappendixname'] = appendix_tuple[1].to_s
-    end
 
-    def erb_content(file)
-      @texcompiler = File.basename(@config['texcommand'], '.*')
-      erb = ReVIEW::Template.load(file, '-')
-      @logger.debug("erb processes #{File.basename(file)}") if @config['debug']
-      erb.result(binding)
+      if @config['pdfmaker']['boxsetting']
+        begin
+          @boxsetting = ReVIEW::LaTeXBox.new.tcbox(@config)
+        rescue ReVIEW::ConfigError => e
+          error e
+        end
+      end
     end
 
     def latex_config
-      result = erb_content(File.expand_path('./latex/config.erb', ReVIEW::Template::TEMPLATE_DIR))
+      result = ReVIEW::Template.generate(path: './latex/config.erb', mode: '-', binding: binding)
       local_config_file = File.join(@basedir, 'layouts', 'config-local.tex.erb')
       if File.exist?(local_config_file)
         result << "%% BEGIN: config-local.tex.erb\n"
-        result << erb_content(local_config_file)
+        result << ReVIEW::Template.generate(path: 'layouts/config-local.tex.erb', mode: '-', binding: binding, template_dir: @basedir)
         result << "%% END: config-local.tex.erb\n"
       end
       result
     end
 
     def template_content
-      template = File.expand_path('./latex/layout.tex.erb', ReVIEW::Template::TEMPLATE_DIR)
+      template_dir = ReVIEW::Template::TEMPLATE_DIR
       if @config.check_version('2', exception: false)
-        template = File.expand_path('./latex-compat2/layout.tex.erb', ReVIEW::Template::TEMPLATE_DIR)
+        template_path = './latex-compat2/layout.tex.erb'
+      else
+        template_path = './latex/layout.tex.erb'
       end
       layout_file = File.join(@basedir, 'layouts', 'layout.tex.erb')
       if File.exist?(layout_file)
-        template = layout_file
+        template_dir = @basedir
+        template_path = 'layouts/layout.tex.erb'
       end
-      erb_content(template)
+      ReVIEW::Template.generate(path: template_path, mode: '-', binding: binding, template_dir: template_dir)
     end
 
     def copy_sty(dirname, copybase, extname = 'sty')
@@ -486,6 +497,7 @@ module ReVIEW
       Dir.open(dirname) do |dir|
         dir.sort.each do |fname|
           next unless File.extname(fname).downcase == '.' + extname
+
           FileUtils.mkdir_p(copybase) unless Dir.exist?(copybase)
           if extname == 'erb'
             File.open(File.join(copybase, fname.sub(/\.erb\Z/, '')), 'w') do |f|
@@ -497,15 +509,5 @@ module ReVIEW
         end
       end
     end
-
-    def call_hook(hookname)
-      return if !@config['pdfmaker'].is_a?(Hash) || @config['pdfmaker'][hookname].nil?
-      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
-        system_or_raise(hook, Dir.pwd, @basedir)
-      end
-    end
   end
 end