review 3.2.0 → 5.1.0

data/lib/review/markdownbuilder.rb

@@ -1,3 +1,5 @@
+# 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
 # the GNU LGPL, Lesser General Public License version 2.1.
@@ -50,11 +52,11 @@ module ReVIEW
 
     def paragraph(lines)
       if @noindent
-        puts %Q(<p class="noindent">#{lines.join}</p>)
+        puts %Q(<p class="noindent">#{join_lines_to_paragraph(lines)}</p>)
         puts "\n"
         @noindent = nil
       else
-        puts lines.join
+        puts join_lines_to_paragraph(lines)
         puts "\n"
       end
     end
@@ -63,24 +65,26 @@ module ReVIEW
       @noindent = true
     end
 
-    def list_header(id, caption, lang)
+    def list_header(id, caption, _lang)
       if get_chap.nil?
         print %Q(リスト#{@chapter.list(id).number} #{compile_inline(caption)}\n\n)
       else
         print %Q(リスト#{get_chap}.#{@chapter.list(id).number} #{compile_inline(caption)}\n\n)
       end
-      lang ||= ''
-      puts "```#{lang}"
     end
 
-    def list_body(_id, lines, _lang)
+    def list_body(_id, lines, lang)
+      lang ||= ''
+      puts "```#{lang}"
       lines.each do |line|
         puts detab(line)
       end
       puts '```'
     end
 
-    def listnum_body(lines, _lang)
+    def listnum_body(lines, lang)
+      lang ||= ''
+      puts "```#{lang}"
       lines.each_with_index do |line, i|
         puts((i + 1).to_s.rjust(2) + ": #{detab(line)}")
       end
@@ -93,7 +97,7 @@ module ReVIEW
     end
 
     def ul_item_begin(lines)
-      puts '  ' * (@ul_indent - 1) + '* ' + lines.join
+      puts '  ' * (@ul_indent - 1) + '* ' + join_lines_to_paragraph(lines)
     end
 
     def ul_item_end
@@ -109,7 +113,7 @@ module ReVIEW
     end
 
     def ol_item(lines, num)
-      puts "#{num}. #{lines.join}"
+      puts "#{num}. #{join_lines_to_paragraph(lines)}"
     end
 
     def ol_end
@@ -125,7 +129,7 @@ module ReVIEW
     end
 
     def dd(lines)
-      puts "<dd>#{lines.join}</dd>"
+      puts "<dd>#{join_lines_to_paragraph(lines)}</dd>"
     end
 
     def dl_end
@@ -134,9 +138,9 @@ module ReVIEW
 
     def emlist(lines, caption = nil, lang = nil)
       blank
-      if caption
+      if caption.present?
         puts caption
-        print "\n"
+        blank
       end
       lang ||= ''
       puts "```#{lang}"
@@ -151,10 +155,28 @@ module ReVIEW
       puts %Q(<div class="#{type}">)
       puts %Q(<p class="caption">#{compile_inline(caption)}</p>) if caption.present?
       blocked_lines = split_paragraph(lines)
-      puts blocked_lines.join("\n")
+      puts blocked_lines.join("\n\n")
       puts '</div>'
     end
 
+    CAPTION_TITLES.each do |name|
+      class_eval %Q(
+        def #{name}_begin(caption = nil)
+          check_nested_minicolumn
+          @doc_status[:minicolumn] = '#{name}'
+          puts %Q(<div class="#{name}">)
+          if caption.present?
+            puts %Q(<p class="caption">\#{compile_inline(caption)}</p>)
+          end
+        end
+
+        def #{name}_end
+          puts '</div>'
+          @doc_status[:minicolumn] = nil
+        end
+      ), __FILE__, __LINE__ - 14
+    end
+
     def hr
       puts '----'
     end
@@ -202,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\./}, '')})"
@@ -222,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\./}, '')})"
@@ -236,7 +288,11 @@ module ReVIEW
       'jpg'
     end
 
-    def cmd(lines)
+    def cmd(lines, caption = nil)
+      if caption.present?
+        puts caption
+        blank
+      end
       puts '```shell-session'
       lines.each do |line|
         puts detab(line)
@@ -244,32 +300,12 @@ module ReVIEW
       puts '```'
     end
 
-    def table(lines, id = nil, caption = nil)
-      rows = []
-      sepidx = nil
-      lines.each_with_index do |line, idx|
-        if /\A[\=\-]{12}/ =~ line
-          # just ignore
-          # error "too many table separator" if sepidx
-          sepidx ||= idx
-          next
-        end
-        rows.push(line.strip.split(/\t+/).map { |s| s.sub(/\A\./, '') })
-      end
-      rows = adjust_n_cols(rows)
-      error 'no rows in the table' if rows.empty?
-
-      begin
-        table_header id, caption unless caption.nil?
-      rescue KeyError
-        error "no such table: #{id}"
-      end
-      table_begin rows.first.size
+    def table_rows(sepidx, rows)
       if sepidx
         sepidx.times do
           tr(rows.shift.map { |s| th(s) })
         end
-        table_border rows.first.size
+        table_border(rows.first.size)
         rows.each do |cols|
           tr(cols.map { |s| td(s) })
         end
@@ -279,7 +315,6 @@ module ReVIEW
           tr([th(h)] + cs.map { |s| td(s) })
         end
       end
-      table_end
     end
 
     def table_header(id, caption)
@@ -353,9 +388,10 @@ module ReVIEW
 
     def comment(lines, comment = nil)
       return unless @book.config['draft']
+
       lines ||= []
       unless comment.blank?
-        lines.unshift comment
+        lines.unshift(comment)
       end
       str = lines.join('<br />')
       puts %Q(<div class="red">#{escape(str)}</div>)
@@ -380,7 +416,7 @@ module ReVIEW
 
     def flushright(lines)
       puts %Q(<div class="flushright">)
-      puts lines.join
+      puts split_paragraph(lines).join("\n")
       puts %Q(</div>)
     end
   end

data/lib/review/md2inaobuilder.rb

@@ -7,13 +7,11 @@ require 'review/markdownbuilder'
 module ReVIEW
   class MD2INAOBuilder < MARKDOWNBuilder
     def paragraph(lines)
-      puts '　' + lines.join
+      puts '　' + join_lines_to_paragraph(lines)
       puts "\n"
     end
 
-    def list_header(id, caption, lang)
-      lang ||= ''
-      puts "```#{lang}"
+    def list_header(id, caption, _lang)
       print %Q(●リスト#{@chapter.list(id).number}::#{compile_inline(caption)}\n\n)
     end
 
@@ -35,7 +33,7 @@ module ReVIEW
     end
 
     def dd(lines)
-      puts "<dd>#{lines.join}</dd>"
+      puts "<dd>#{join_lines_to_paragraph(lines)}</dd>"
     end
 
     def dl_end

data/lib/review/pdfmaker.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2018 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
 
@@ -54,12 +57,12 @@ module ReVIEW
     end
 
     def error(msg)
-      @logger.error "#{File.basename($PROGRAM_NAME, '.*')}: #{msg}"
+      @logger.error msg
       exit 1
     end
 
     def warn(msg)
-      @logger.warn "#{File.basename($PROGRAM_NAME, '.*')}: #{msg}"
+      @logger.warn msg
     end
 
     def pdf_filepath
@@ -100,6 +103,7 @@ module ReVIEW
     def parse_opts(args)
       cmd_config = {}
       opts = OptionParser.new
+      @buildonly = nil
 
       opts.banner = 'Usage: review-pdfmaker configfile'
       opts.version = ReVIEW::VERSION
@@ -109,6 +113,7 @@ module ReVIEW
       end
       opts.on('--[no-]debug', 'Keep temporary files.') { |debug| cmd_config['debug'] = debug }
       opts.on('--ignore-errors', 'Ignore review-compile errors.') { cmd_config['ignore-errors'] = true }
+      opts.on('-y', '--only file1,file2,...', 'Build only specified files.') { |v| @buildonly = v.split(/\s*,\s*/).map { |m| m.strip.sub(/\.re\Z/, '') } }
 
       opts.parse!(args)
       if args.size != 1
@@ -120,20 +125,13 @@ module ReVIEW
     end
 
     def execute(*args)
-      @config = ReVIEW::Configure.values
-      @config.maker = 'pdfmaker'
       cmd_config, yamlfile = parse_opts(args)
       error "#{yamlfile} not found." unless File.exist?(yamlfile)
 
-      begin
-        loader = ReVIEW::YAMLLoader.new
-        @config.deep_merge!(loader.load_file(yamlfile))
-      rescue => e
-        error "yaml error #{e.message}"
-      end
+      @config = ReVIEW::Configure.create(maker: 'pdfmaker',
+                                         yamlfile: yamlfile,
+                                         config: cmd_config)
 
-      # YAML configs will be overridden by command line options.
-      @config.deep_merge!(cmd_config)
       I18n.setup(@config['language'])
       @basedir = File.absolute_path(File.dirname(yamlfile))
 
@@ -153,21 +151,27 @@ module ReVIEW
       end
 
       begin
-        generate_pdf(yamlfile)
+        generate_pdf
       rescue ApplicationError => e
         raise if @config['debug']
+
         error(e.message)
       end
     end
 
-    def make_input_files(book, yamlfile)
+    def make_input_files(book)
       input_files = Hash.new { |h, key| h[key] = '' }
       book.parts.each do |part|
         if part.name.present?
           @config['use_part'] = true
           if part.file?
-            output_chaps(part.name, yamlfile)
-            input_files['CHAPS'] << %Q(\\input{#{part.name}.tex}\n)
+            if @buildonly && !@buildonly.include?(part.name)
+              warn "skip #{part.name}.re"
+              input_files['CHAPS'] << %Q(\\part{}\n)
+            else
+              output_chaps(part.name)
+              input_files['CHAPS'] << %Q(\\input{#{part.name}.tex}\n)
+            end
           else
             input_files['CHAPS'] << %Q(\\part{#{part.name}}\n)
           end
@@ -175,11 +179,18 @@ module ReVIEW
 
         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?
+          entry = "\\input{#{filename}.tex}\n"
+          if @buildonly && !@buildonly.include?(filename)
+            warn "skip #{filename}.re"
+            entry = "\\chapter{}\n"
+          else
+            output_chaps(filename)
+          end
+
+          input_files['PREDEF'] << entry if chap.on_predef?
+          input_files['CHAPS'] << entry if chap.on_chaps?
+          input_files['APPENDIX'] << entry if chap.on_appendix?
+          input_files['POSTDEF'] << entry if chap.on_postdef?
         end
       end
 
@@ -189,9 +200,9 @@ module ReVIEW
     def build_pdf
       template = template_content
       Dir.chdir(@path) do
-        File.open("./#{@mastertex}.tex", 'wb') { |f| f.write(template) }
+        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
@@ -234,34 +245,34 @@ module ReVIEW
           system_or_raise(*[texcommand, texoptions, "#{@mastertex}.tex"].flatten.compact)
         end
 
-        call_hook('hook_beforemakeindex')
-        if @config['pdfmaker']['makeindex'] && File.exist?("#{@mastertex}.idx")
+        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(yamlfile)
+    def generate_pdf
       remove_old_file
-      erb_config
       @path = build_path
       begin
         @compile_errors = nil
 
-        book = ReVIEW::Book.load(File.dirname(yamlfile))
-        book.config = @config
+        book = ReVIEW::Book::Base.new(@basedir, config: @config)
         @converter = ReVIEW::Converter.new(book, ReVIEW::LATEXBuilder.new)
+        erb_config
 
-        @input_files = make_input_files(book, yamlfile)
+        @input_files = make_input_files(book)
 
         check_compile_status(@config['ignore-errors'])
 
@@ -280,12 +291,13 @@ 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']
+        remove_entry_secure(@path) unless @config['debug']
       end
     end
 
-    def output_chaps(filename, _yamlfile)
+    def output_chaps(filename)
       @logger.info "compiling #{filename}.tex"
       begin
         @converter.convert(filename + '.re', File.join(@path, filename + '.tex'))
@@ -296,23 +308,13 @@ module ReVIEW
       end
     end
 
-    # PDFMaker#copy_images should copy image files _AND_ execute extractbb (or ebb).
+    # PDFMaker#copy_images should copy image files
     #
     def copy_images(from, to)
       return unless File.exist?(from)
+
       Dir.mkdir(to)
       ReVIEW::MakerHelper.copy_images_to_dir(from, to)
-      Dir.chdir(to) do
-        images = Dir.glob('**/*').find_all { |f| File.file?(f) and f =~ /\.(jpg|jpeg|png|pdf|ai|eps|tif)\z/i }
-        break if images.empty?
-        if @config['pdfmaker']['bbox']
-          system_with_info('extractbb', '-B', @config['pdfmaker']['bbox'], *images)
-          system_or_raise('ebb', '-B', @config['pdfmaker']['bbox'], *images) unless system('extractbb', '-B', @config['pdfmaker']['bbox'], '-m', *images)
-        else
-          system_with_info('extractbb', *images)
-          system_or_raise('ebb', *images) unless system('extractbb', '-m', *images)
-        end
-      end
     end
 
     def make_custom_page(file)
@@ -320,6 +322,7 @@ module ReVIEW
       if File.exist?(file_sty)
         return File.read(file_sty)
       end
+
       nil
     end
 
@@ -370,11 +373,11 @@ module ReVIEW
           items.each_with_index do |item, rev|
             editstr = edit == 0 ? ReVIEW::I18n.t('first_edition') : ReVIEW::I18n.t('nth_edition', (edit + 1).to_s)
             revstr = ReVIEW::I18n.t('nth_impression', (rev + 1).to_s)
-            if item =~ /\A\d+\-\d+\-\d+\Z/
+            if item =~ /\A\d+-\d+-\d+\Z/
               buf << ReVIEW::I18n.t('published_by1', [date_to_s(item), editstr + revstr])
-            elsif item =~ /\A(\d+\-\d+\-\d+)[\s　](.+)/
+            elsif item =~ /\A(\d+-\d+-\d+)[\s　](.+)/
               # custom date with string
-              item.match(/\A(\d+\-\d+\-\d+)[\s　](.+)/) { |m| buf << ReVIEW::I18n.t('published_by3', [date_to_s(m[1]), m[2]]) }
+              item.match(/\A(\d+-\d+-\d+)[\s　](.+)/) { |m| buf << ReVIEW::I18n.t('published_by3', [date_to_s(m[1]), m[2]]) }
             else
               # free format
               buf << item
@@ -440,38 +443,49 @@ module ReVIEW
       end
 
       @locale_latex = {}
-      part_tuple = I18n.get('part').split(/\%[A-Za-z]{1,3}/, 2)
-      chapter_tuple = I18n.get('chapter').split(/\%[A-Za-z]{1,3}/, 2)
-      appendix_tuple = I18n.get('appendix').split(/\%[A-Za-z]{1,3}/, 2)
-      @locale_latex['prepartname'] = part_tuple[0]
-      @locale_latex['postpartname'] = part_tuple[1]
-      @locale_latex['prechaptername'] = chapter_tuple[0]
-      @locale_latex['postchaptername'] = chapter_tuple[1]
-      @locale_latex['preappendixname'] = appendix_tuple[0]
-      @locale_latex['postappendixname'] = appendix_tuple[1]
-    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)
+      part_tuple = I18n.get('part').split(/%[A-Za-z]{1,3}/, 2)
+      chapter_tuple = I18n.get('chapter').split(/%[A-Za-z]{1,3}/, 2)
+      appendix_tuple = I18n.get('appendix').split(/%[A-Za-z]{1,3}/, 2)
+      @locale_latex['prepartname'] = part_tuple[0].to_s
+      @locale_latex['postpartname'] = part_tuple[1].to_s
+      @locale_latex['prechaptername'] = chapter_tuple[0].to_s
+      @locale_latex['postchaptername'] = chapter_tuple[1].to_s
+      @locale_latex['preappendixname'] = appendix_tuple[0].to_s
+      @locale_latex['postappendixname'] = appendix_tuple[1].to_s
+
+      if @config['pdfmaker']['boxsetting']
+        begin
+          @boxsetting = ReVIEW::LaTeXBox.new.tcbox(@config)
+        rescue ReVIEW::ConfigError => e
+          error e
+        end
+      end
     end
 
     def latex_config
-      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 << 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')
@@ -483,26 +497,17 @@ 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|
               f.print erb_content(File.join(dirname, fname))
             end
           else
-            FileUtils.cp File.join(dirname, fname), copybase
+            FileUtils.cp(File.join(dirname, fname), copybase)
           end
         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