review 5.1.1 → 5.4.0

data/lib/review/markdownbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2020 KADO Masanori, Masayoshi Takahashi, Kenshi Muto
+# Copyright (c) 2013-2021 KADO Masanori, Masayoshi Takahashi, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -18,6 +18,7 @@ module ReVIEW
     end
 
     def builder_init_file
+      super
       @noindent = nil
       @blank_seen = nil
       @ul_indent = 0
@@ -97,7 +98,7 @@ module ReVIEW
     end
 
     def ul_item_begin(lines)
-      puts '  ' * (@ul_indent - 1) + '* ' + join_lines_to_paragraph(lines)
+      puts ('  ' * (@ul_indent - 1)) + '* ' + join_lines_to_paragraph(lines)
     end
 
     def ul_item_end
@@ -245,7 +246,7 @@ module ReVIEW
     def inline_img(id)
       "#{I18n.t('image')}#{@chapter.image(id).number}"
     rescue KeyError
-      error "unknown image: #{id}"
+      app_error "unknown image: #{id}"
     end
 
     def inline_dtp(str)
@@ -254,24 +255,24 @@ module ReVIEW
 
     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
+      str = if n.present? && chap.number && over_secnolevel?(n)
+              I18n.t('hd_quote', [n, compile_inline(chap.headline(id).caption)])
+            else
+              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'
+          warn 'MARKDOWNBuilder does not support links to other chapters', location: location
           str
         end
       else
         str
       end
     rescue KeyError
-      error "unknown headline: #{id}"
+      app_error "unknown headline: #{id}"
     end
 
     def indepimage(_lines, id, caption = '', _metric = nil)
@@ -360,6 +361,14 @@ module ReVIEW
       "[^#{id}]"
     end
 
+    def inline_endnote(id)
+      "<sup>#{I18n.t('html_endnote_refmark', @chapter.endnote(id).number)}</sup>"
+    end
+
+    def endnote_item(id)
+      puts "#{I18n.t('html_endnote_textmark', @chapter.endnote(id).number)}#{compile_inline(@chapter.endnote(id).content)}"
+    end
+
     def inline_br(_str)
       "\n"
     end
@@ -400,8 +409,8 @@ module ReVIEW
     def inline_icon(id)
       begin
         "![](#{@chapter.image(id).path.sub(%r{\A\./}, '')})"
-      rescue
-        warn "image not bound: #{id}"
+      rescue StandardError
+        warn "image not bound: #{id}", location: location
         %Q(<pre>missing image: #{id}</pre>)
       end
     end

data/lib/review/pdfmaker.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2021 Kenshi Muto and Masayoshi Takahashi
+# Copyright (c) 2010-2022 Kenshi Muto and Masayoshi Takahashi
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -24,11 +24,12 @@ require 'review/makerhelper'
 require 'review/template'
 require 'review/latexbox'
 require 'review/call_hook'
+require 'review/loggable'
 
 module ReVIEW
   class PDFMaker
-    include FileUtils
     include ReVIEW::LaTeXUtils
+    include Loggable
     include ReVIEW::CallHook
 
     attr_accessor :config, :basedir
@@ -38,13 +39,14 @@ module ReVIEW
       @logger = ReVIEW.logger
       @input_files = Hash.new { |h, key| h[key] = '' }
       @mastertex = '__REVIEW_BOOK__'
+      @compile_errors = nil
     end
 
     def system_with_info(*args)
       @logger.info args.join(' ')
       out, status = Open3.capture2e(*args)
       unless status.success?
-        @logger.error "execution error\n\nError log:\n" + out
+        error "execution error\n\nError log:\n#{out}"
       end
     end
 
@@ -52,19 +54,10 @@ module ReVIEW
       @logger.info args.join(' ')
       out, status = Open3.capture2e(*args)
       unless status.success?
-        error "failed to run command: #{args.join(' ')}\n\nError log:\n" + out
+        error! "failed to run command: #{args.join(' ')}\n\nError log:\n#{out}"
       end
     end
 
-    def error(msg)
-      @logger.error msg
-      exit 1
-    end
-
-    def warn(msg)
-      @logger.warn msg
-    end
-
     def pdf_filepath
       File.join(@basedir, @config['bookname'] + '.pdf')
     end
@@ -92,7 +85,7 @@ module ReVIEW
       if ignore_errors
         @logger.info 'compile error, but try to generate PDF file'
       else
-        error 'compile error, No PDF file output.'
+        error! 'compile error, No PDF file output.'
       end
     end
 
@@ -126,11 +119,15 @@ module ReVIEW
 
     def execute(*args)
       cmd_config, yamlfile = parse_opts(args)
-      error "#{yamlfile} not found." unless File.exist?(yamlfile)
+      error! "#{yamlfile} not found." unless File.exist?(yamlfile)
 
-      @config = ReVIEW::Configure.create(maker: 'pdfmaker',
-                                         yamlfile: yamlfile,
-                                         config: cmd_config)
+      begin
+        @config = ReVIEW::Configure.create(maker: 'pdfmaker',
+                                           yamlfile: yamlfile,
+                                           config: cmd_config)
+      rescue ReVIEW::ConfigError => e
+        error! e.message
+      end
 
       I18n.setup(@config['language'])
       @basedir = File.absolute_path(File.dirname(yamlfile))
@@ -143,11 +140,11 @@ module ReVIEW
 
       # version 2 compatibility
       unless @config['texdocumentclass']
-        if @config.check_version(2, exception: false)
-          @config['texdocumentclass'] = ['jsbook', 'uplatex,oneside']
-        else
-          @config['texdocumentclass'] = @config['_texdocumentclass']
-        end
+        @config['texdocumentclass'] = if @config.check_version(2, exception: false)
+                                        ['jsbook', 'uplatex,oneside']
+                                      else
+                                        @config['_texdocumentclass']
+                                      end
       end
 
       begin
@@ -155,7 +152,7 @@ module ReVIEW
       rescue ApplicationError => e
         raise if @config['debug']
 
-        error(e.message)
+        error! e.message
       end
     end
 
@@ -200,7 +197,7 @@ module ReVIEW
     def build_pdf
       template = template_content
       Dir.chdir(@path) do
-        File.open("./#{@mastertex}.tex", 'wb') { |f| f.write template }
+        File.write("./#{@mastertex}.tex", template)
 
         call_hook('hook_beforetexcompile', Dir.pwd, @basedir, base_dir: @basedir)
 
@@ -217,7 +214,7 @@ module ReVIEW
           makeindex_dic = ReVIEW::Configure.values['pdfmaker']['makeindex_dic']
         else
           unless @config['texcommand'].present?
-            error "texcommand isn't defined."
+            error! "texcommand isn't defined."
           end
           texcommand = @config['texcommand']
           dvicommand = @config['dvicommand']
@@ -280,6 +277,9 @@ module ReVIEW
         @config['usepackage'] = ''
         @config['usepackage'] = "\\usepackage{#{@config['texstyle']}}" if @config['texstyle']
 
+        if @config['pdfmaker']['use_symlink']
+          logger.info 'use symlink'
+        end
         copy_images(@config['imagedir'], File.join(@path, @config['imagedir']))
         copy_sty(File.join(Dir.pwd, 'sty'), @path)
         copy_sty(File.join(Dir.pwd, 'sty'), @path, 'fd')
@@ -293,7 +293,7 @@ module ReVIEW
         FileUtils.cp(File.join(@path, "#{@mastertex}.pdf"), pdf_filepath)
         @logger.success("built #{File.basename(pdf_filepath)}")
       ensure
-        remove_entry_secure(@path) unless @config['debug']
+        FileUtils.remove_entry_secure(@path) unless @config['debug']
       end
     end
 
@@ -301,10 +301,10 @@ module ReVIEW
       @logger.info "compiling #{filename}.tex"
       begin
         @converter.convert(filename + '.re', File.join(@path, filename + '.tex'))
-      rescue => e
+      rescue StandardError => e
         @compile_errors = true
-        warn "compile error in #{filename}.tex (#{e.class})"
-        warn e.message
+        error "compile error in #{filename}.tex (#{e.class})"
+        error e.message
       end
     end
 
@@ -314,16 +314,24 @@ module ReVIEW
       return unless File.exist?(from)
 
       Dir.mkdir(to)
-      ReVIEW::MakerHelper.copy_images_to_dir(from, to)
+      if @config['pdfmaker']['use_symlink']
+        ReVIEW::MakerHelper.copy_images_to_dir(from, to, use_symlink: true)
+      else
+        ReVIEW::MakerHelper.copy_images_to_dir(from, to)
+      end
     end
 
     def make_custom_page(file)
+      if file.nil?
+        return nil
+      end
+
       file_sty = file.to_s.sub(/\.[^.]+\Z/, '.tex')
       if File.exist?(file_sty)
-        return File.read(file_sty)
+        File.read(file_sty)
+      else
+        warn "File #{file_sty} is not found."
       end
-
-      nil
     end
 
     def join_with_separator(value, sep)
@@ -373,9 +381,9 @@ 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 /\A\d+-\d+-\d+\Z/.match?(item)
               buf << ReVIEW::I18n.t('published_by1', [date_to_s(item), editstr + revstr])
-            elsif item =~ /\A(\d+-\d+-\d+)[\s　](.+)/
+            elsif /\A(\d+-\d+-\d+)[\s　](.+)/.match?(item)
               # 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]]) }
             else
@@ -442,6 +450,10 @@ module ReVIEW
           end
       end
 
+      if @config['coverimage'] && !File.exist?(File.join(@config['imagedir'], @config['coverimage']))
+        raise ReVIEW::ConfigError, "coverimage #{@config['coverimage']} is not found."
+      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)
@@ -457,7 +469,7 @@ module ReVIEW
         begin
           @boxsetting = ReVIEW::LaTeXBox.new.tcbox(@config)
         rescue ReVIEW::ConfigError => e
-          error e
+          error! e
         end
       end
     end
@@ -475,17 +487,24 @@ module ReVIEW
 
     def template_content
       template_dir = ReVIEW::Template::TEMPLATE_DIR
-      if @config.check_version('2', exception: false)
-        template_path = './latex-compat2/layout.tex.erb'
-      else
-        template_path = './latex/layout.tex.erb'
-      end
+      template_path = if @config.check_version('2', exception: false)
+                        './latex-compat2/layout.tex.erb'
+                      else
+                        './latex/layout.tex.erb'
+                      end
       layout_file = File.join(@basedir, 'layouts', 'layout.tex.erb')
       if File.exist?(layout_file)
         template_dir = @basedir
         template_path = 'layouts/layout.tex.erb'
       end
       ReVIEW::Template.generate(path: template_path, mode: '-', binding: binding, template_dir: template_dir)
+    rescue StandardError => e
+      if defined?(e.full_message)
+        error! "template or configuration error: #{e.full_message(highlight: false)}"
+      else
+        # <= Ruby 2.4
+        error! "template or configuration error: #{e.message}"
+      end
     end
 
     def copy_sty(dirname, copybase, extname = 'sty')
@@ -503,6 +522,8 @@ module ReVIEW
             File.open(File.join(copybase, fname.sub(/\.erb\Z/, '')), 'w') do |f|
               f.print erb_content(File.join(dirname, fname))
             end
+          elsif @config['pdfmaker']['use_symlink']
+            FileUtils.ln_s(File.join(dirname, fname), copybase)
           else
             FileUtils.cp(File.join(dirname, fname), copybase)
           end

data/lib/review/plaintextbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2018-2020 Kenshi Muto
+# Copyright (c) 2018-2021 Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -42,12 +42,12 @@ module ReVIEW
     end
 
     def builder_init_file
+      super
       @section = 0
       @subsection = 0
       @subsubsection = 0
       @subsubsubsection = 0
       @blank_seen = true
-      @sec_counter = SecCounter.new(5, @chapter)
     end
     private :builder_init_file
 
@@ -74,6 +74,7 @@ module ReVIEW
     private :blank
 
     def result
+      check_printendnotes
       solve_nest(@output.string)
     end
 
@@ -85,11 +86,11 @@ module ReVIEW
         if l =~ /\A\x01→(dl|ul|ol)←\x01/
           clevel.push($1)
           lines.push("\x01→END←\x01")
-        elsif l =~ %r{\A\x01→/(dl|ul|ol)←\x01}
+        elsif %r{\A\x01→/(dl|ul|ol)←\x01}.match?(l)
           clevel.pop
           lines.push("\x01→END←\x01")
         else
-          lines.push("\t" * clevel.size + l)
+          lines.push(("\t" * clevel.size) + l)
         end
       end
 
@@ -169,7 +170,7 @@ module ReVIEW
           list_header(id, caption, lang)
         end
       rescue KeyError
-        error "no such list: #{id}"
+        app_error "no such list: #{id}"
       end
       blank
     end
@@ -213,14 +214,14 @@ module ReVIEW
 
     def emlistnum(lines, caption = nil, _lang = nil)
       blank
-      if caption_top?('list')
-        puts compile_inline(caption) if caption.present?
+      if caption_top?('list') && caption.present?
+        puts compile_inline(caption)
       end
       lines.each_with_index do |line, i|
         puts((i + 1).to_s.rjust(2) + ": #{line}")
       end
-      unless caption_top?('list')
-        puts compile_inline(caption) if caption.present?
+      if !caption_top?('list') && caption.present?
+        puts compile_inline(caption)
       end
       blank
     end
@@ -238,7 +239,7 @@ module ReVIEW
           list_header(id, caption, lang)
         end
       rescue KeyError
-        error "no such list: #{id}"
+        app_error "no such list: #{id}"
       end
       blank
     end
@@ -337,7 +338,7 @@ module ReVIEW
     def inline_fn(id)
       " 注#{@chapter.footnote(id).number} "
     rescue KeyError
-      error "unknown footnote: #{id}"
+      app_error "unknown footnote: #{id}"
     end
 
     def compile_ruby(base, _ruby)
@@ -401,7 +402,7 @@ module ReVIEW
     def inline_bib(id)
       %Q(#{@chapter.bibpaper(id).number} )
     rescue KeyError
-      error "unknown bib: #{id}"
+      app_error "unknown bib: #{id}"
     end
 
     def inline_hd_chap(chap, id)
@@ -412,7 +413,7 @@ module ReVIEW
         I18n.t('hd_quote_without_number', compile_inline(chap.headline(id).caption))
       end
     rescue KeyError
-      error "unknown headline: #{id}"
+      app_error "unknown headline: #{id}"
     end
 
     def noindent
@@ -680,7 +681,7 @@ module ReVIEW
         if @book.config['chapref']
           chs2 = @book.config['chapref'].split(',')
           if chs2.size != 3
-            error '--chapsplitter must have exactly 3 parameters with comma.'
+            app_error '--chapsplitter must have exactly 3 parameters with comma.'
           end
           chs = chs2
         end
@@ -694,7 +695,7 @@ module ReVIEW
         end
       end
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
     end
 
     def source(lines, caption = nil, _lang = nil)

data/lib/review/preprocessor/directive.rb

@@ -0,0 +1,35 @@
+# Copyright (c) 2010-2021 Minero Aoki, 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".
+#
+
+module ReVIEW
+  class Preprocessor
+    class Directive
+      def initialize(op, args, opts)
+        @op = op
+        @args = args
+        @opts = opts
+      end
+
+      attr_reader :op
+      attr_reader :args
+      attr_reader :opts
+
+      def arg
+        @args.first
+      end
+
+      def opt
+        @opts.first
+      end
+
+      def [](key)
+        @opts[key]
+      end
+    end
+  end
+end

data/lib/review/preprocessor/line.rb

@@ -0,0 +1,34 @@
+# Copyright (c) 2010-2021 Minero Aoki, 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".
+#
+
+module ReVIEW
+  class Preprocessor
+    class Line
+      def initialize(number, string)
+        @number = number
+        @string = string
+      end
+
+      attr_reader :number
+      attr_reader :string
+      alias_method :to_s, :string
+
+      def edit
+        self.class.new(@number, yield(@string))
+      end
+
+      def empty?
+        @string.strip.empty?
+      end
+
+      def num_indent
+        @string.slice(/\A\s*/).size
+      end
+    end
+  end
+end