review 5.1.1 → 5.2.0

data/lib/review/makerhelper.rb

@@ -61,7 +61,11 @@ module ReVIEW
             exts = options[:exts] || %w[png gif jpg jpeg svg pdf eps ai tif psd]
             exts_str = exts.join('|')
             if !is_converted && fname =~ /\.(#{exts_str})$/i
-              FileUtils.cp("#{from_dir}/#{fname}", to_dir)
+              if options[:use_symlink]
+                FileUtils.ln_s(File.realpath("#{from_dir}/#{fname}"), to_dir)
+              else
+                FileUtils.cp("#{from_dir}/#{fname}", to_dir)
+              end
               image_files << "#{from_dir}/#{fname}"
             end
           end

data/lib/review/markdownbuilder.rb

@@ -18,6 +18,7 @@ module ReVIEW
     end
 
     def builder_init_file
+      super
       @noindent = nil
       @blank_seen = nil
       @ul_indent = 0
@@ -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)
@@ -264,14 +265,14 @@ module ReVIEW
           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)
@@ -401,7 +402,7 @@ module ReVIEW
       begin
         "![](#{@chapter.image(id).path.sub(%r{\A\./}, '')})"
       rescue
-        warn "image not bound: #{id}"
+        warn "image not bound: #{id}", location: location
         %Q(<pre>missing image: #{id}</pre>)
       end
     end

data/lib/review/pdfmaker.rb

@@ -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,7 +119,7 @@ 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,
@@ -155,7 +148,7 @@ module ReVIEW
       rescue ApplicationError => e
         raise if @config['debug']
 
-        error(e.message)
+        error! e.message
       end
     end
 
@@ -217,7 +210,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 +273,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 +289,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
 
@@ -303,8 +299,8 @@ module ReVIEW
         @converter.convert(filename + '.re', File.join(@path, filename + '.tex'))
       rescue => 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,7 +310,11 @@ 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)
@@ -457,7 +457,7 @@ module ReVIEW
         begin
           @boxsetting = ReVIEW::LaTeXBox.new.tcbox(@config)
         rescue ReVIEW::ConfigError => e
-          error e
+          error! e
         end
       end
     end
@@ -503,6 +503,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

@@ -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
 
@@ -169,7 +169,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
@@ -238,7 +238,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 +337,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 +401,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 +412,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 +680,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 +694,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.rb

@@ -9,119 +9,109 @@
 
 require 'review/textutils'
 require 'review/exception'
-require 'nkf'
+require 'review/preprocessor/directive'
+require 'review/preprocessor/line'
+require 'review/preprocessor/repository'
+require 'review/loggable'
+require 'open3'
 
 module ReVIEW
-  module ErrorUtils
-    def init_errorutils(f)
-      @errutils_file = f
-      @errutils_err = false
-    end
-
-    def warn(msg)
-      @logger.warn "#{location}: #{msg}"
-    end
-
-    def error(msg)
-      @errutils_err = true
-      raise ApplicationError, "#{location}: #{msg}"
-    end
-
-    def location
-      "#{filename}:#{lineno}"
-    end
-
-    def filename
-      @errutils_file.path
-    end
-
-    def lineno
-      @errutils_file.lineno
-    end
-  end
-
   class Preprocessor
-    include ErrorUtils
+    include Loggable
+
+    TYPES = %w[file range].freeze
+    KNOWN_DIRECTIVES = %w[require provide warn ok].freeze
+    INF_INDENT = 9999
 
-    def initialize(repo, param)
-      @repository = repo
-      @config = param
+    def initialize(param)
+      @repository = ReVIEW::Preprocessor::Repository.new(param)
+      @config = param ## do not use params in this class; only used in Repository
       @logger = ReVIEW.logger
       @leave_content = nil
     end
 
-    def process(inf, outf)
-      init_errorutils(inf)
-      @f = outf
-      begin
-        preproc(inf)
-      rescue Errno::ENOENT => e
-        error e.message
+    def process(path)
+      File.open(path) do |inf|
+        @inf = inf
+        @f = StringIO.new
+        begin
+          preproc(@inf)
+        rescue Errno::ENOENT => e
+          error! e.message
+        end
+        @f.string
       end
     end
 
     private
 
-    TYPES = %w[file range].freeze
-
     def preproc(f)
-      init_vars
-      f.each_line do |line|
-        case line
-        when /\A\#@\#/, /\A\#\#\#\#/
-          @f.print line
-
-        when /\A\#@defvar/
-          @f.print line
-          direc = parse_directive(line, 2)
-          defvar(*direc.args)
+      @vartable = {}
+      @has_errors = false
 
-        when /\A\#@mapoutput/
-          direc = parse_directive(line, 1, 'stderr')
-          @f.print line
-          get_output(expand(direc.arg), direc['stderr']).each { |out| @f.print out.string }
-          skip_list(f)
-
-        when /\A\#@mapfile/
-          direc = parse_directive(line, 1, 'eval')
-          path = expand(direc.arg)
-          @leave_content = File.extname(path) == '.re'
-          if direc['eval']
-            ent = evaluate(path, ent)
-          else
-            ent = @repository.fetch_file(path)
-          end
-          replace_block(f, line, ent, false) # FIXME: turn off lineno: tmp
+      f.each_line do |line|
+        begin
+          case line
+          when /\A\#@\#/, /\A\#\#\#\#/
+            @f.print line
 
-        when /\A\#@map(?:range)?/
-          direc = parse_directive(line, 2, 'unindent')
-          path = expand(direc.args[0])
-          @leave_content = File.extname(path) == '.re'
-          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
+          when /\A\#@defvar/
+            @f.print line
+            direc = parse_directive(line, 2)
+            defvar(*direc.args)
 
-        when /\A\#@end/
-          error 'unbaranced #@end'
+          when /\A\#@mapoutput/
+            direc = parse_directive(line, 1, 'stderr')
+            @f.print line
+            get_output(expand(direc.arg), direc['stderr']).each { |out| @f.print out.string }
+            skip_list(f)
+
+          when /\A\#@mapfile/
+            direc = parse_directive(line, 1, 'eval')
+            path = expand(direc.arg)
+            @leave_content = File.extname(path) == '.re'
+            if direc['eval']
+              ent = evaluate(path, ent)
+            else
+              ent = @repository.fetch_file(path)
+            end
+            replace_block(f, line, ent, false) # FIXME: turn off lineno: tmp
+
+          when /\A\#@map(?:range)?/
+            direc = parse_directive(line, 2, 'unindent')
+            path = expand(direc.args[0])
+            @leave_content = File.extname(path) == '.re'
+            ent = @repository.fetch_range(path, direc.args[1]) or
+              app_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
+
+          when /\A\#@end/
+            app_error 'unbaranced #@end'
+
+          when /\A\#@/
+            op = line.slice(/@(\w+)/, 1)
+            warn "unknown directive: #{line.strip}", location: location unless known_directive?(op)
+            if op == 'warn'
+              warn line.strip.sub(/\#@warn\((.+)\)/, '\1'), location: location
+            end
+            @f.print line
 
-        when /\A\#@/
-          op = line.slice(/@(\w+)/, 1)
-          warn "unknown directive: #{line.strip}" unless known_directive?(op)
-          if op == 'warn'
-            warn line.strip.sub(/\#@warn\((.+)\)/, '\1')
+          when /\A\s*\z/ # empty line
+            @f.puts
+          else # rubocop:disable Lint/DuplicateBranch
+            @f.print line
           end
-          @f.print line
-
-        when /\A\s*\z/ # empty line
-          @f.puts
-        else # rubocop:disable Lint/DuplicateBranch
-          @f.print line
+        rescue ApplicationError => e
+          @has_errors = true
+          error e.message, location: location
         end
       end
-    end
 
-    KNOWN_DIRECTIVES = %w[require provide warn ok].freeze
+      if @has_erros
+        error! 'preprocessor failed.'
+      end
+    end
 
     def known_directive?(op)
       KNOWN_DIRECTIVES.index(op)
@@ -151,47 +141,23 @@ module ReVIEW
           return nil
         when %r{\A//\}}
           unless @leave_content
-            warn '//} seen in list'
+            warn '//} seen in list', location: location
             @f.print line
             return nil
           end
         when /\A\#@\w/
-          warn "#{line.slice(/\A\#@\w+/)} seen in list"
+          warn "#{line.slice(/\A\#@\w+/)} seen in list", location: location
           @f.print line
         when /\A\#@/
           @f.print line
         end
       end
-      error "list reached end of file (beginning line = #{begline})"
-    end
-
-    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
+      app_error "list reached end of file (beginning line = #{begline})"
     end
 
     def parse_directive(line, argc, *optdecl)
       m = /\A\#@(\w+)\((.*?)\)(?:\[(.*?)\])?\z/.match(line.strip) or
-        error "wrong directive: #{line.strip}"
+        app_error "wrong directive: #{line.strip}"
       op = m[1]
       args = m[2].split(/,\s*/)
       opts = parse_optargs(m[3])
@@ -200,12 +166,12 @@ module ReVIEW
       if argc == -1
         # Any number of arguments are allowed.
       elsif args.size != argc
-        error 'wrong arg size'
+        app_error 'wrong arg size'
       end
       if opts
         wrong_opts = opts.keys - optdecl
         unless wrong_opts.empty?
-          error "wrong option: #{wrong_opts.keys.join(' ')}"
+          app_error "wrong option: #{wrong_opts.keys.join(' ')}"
         end
       end
       Directive.new(op, args, opts || {})
@@ -237,10 +203,6 @@ module ReVIEW
       end
     end
 
-    def init_vars
-      @vartable = {}
-    end
-
     def defvar(name, value)
       @vartable[name] = value
     end
@@ -258,8 +220,6 @@ module ReVIEW
       chunk.map { |line| line.edit { |s| s.sub(re, '') } }
     end
 
-    INF_INDENT = 9999
-
     def minimum_indent(chunk)
       n = chunk.map { |line| line.empty? ? INF_INDENT : line.num_indent }.min
       n == INF_INDENT ? 0 : n
@@ -277,8 +237,6 @@ module ReVIEW
       end
     end
 
-    require 'open3'
-
     def get_output(cmd, use_stderr)
       out = err = nil
       Open3.popen3(cmd) do |_stdin, stdout, stderr|
@@ -292,182 +250,22 @@ module ReVIEW
       if err && !err.empty?
         $stderr.puts '[unexpected stderr message]'
         err.each { |line| $stderr.print line }
-        error 'get_output: got unexpected output'
+        app_error 'get_output: got unexpected output'
       end
       num = 0
       out.map { |line| Line.new(num += 1, line) }
     end
-  end
-
-  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
-
-  class Repository
-    include TextUtils
-    include ErrorUtils
-
-    def initialize(param)
-      @repository = {}
-      @config = param
-      @logger = ReVIEW.logger
-    end
-
-    def fetch_file(file)
-      file_descripter(file)['file']
-    end
-
-    def fetch_range(file, name)
-      fetch(file, 'range', name)
-    end
-
-    def fetch(file, type, name)
-      table = file_descripter(file)[type] or return nil
-      table[name]
-    end
 
-    private
-
-    def file_descripter(fname)
-      @leave_content = File.extname(fname) == '.re'
-      return @repository[fname] if @repository[fname]
-
-      @repository[fname] = git?(fname) ? parse_git_blob(fname) : parse_file(fname)
-    end
-
-    def git?(fname)
-      fname.start_with?('git|')
-    end
-
-    def parse_git_blob(g_obj)
-      IO.popen('git show ' + g_obj.sub(/\Agit\|/, ''), 'r') do |f|
-        init_errorutils(f)
-        return _parse_file(f)
-      end
-    end
-
-    def parse_file(fname)
-      File.open(fname, 'rt:BOM|utf-8') do |f|
-        init_errorutils(f)
-        return _parse_file(f)
-      end
-    end
-
-    def _parse_file(f)
-      whole = []
-      repo = { 'file' => whole }
-      curr = { 'WHOLE' => whole }
-      lineno = 1
-      yacchack = false # remove ';'-only lines.
-      opened = [['(not opened)', '(not opened)']] * 3
-
-      f.each do |line|
-        case line
-        when /(?:\A\#@|\#@@)([a-z]+)_(begin|end)\((.*)\)/
-          type = check_type($1)
-          direction = $2
-          spec = check_spec($3)
-          case direction
-          when 'begin'
-            key = "#{type}/#{spec}"
-            if curr[key]
-              error "begin x2: #{key}"
-            end
-            (repo[type] ||= {})[spec] = curr[key] = []
-          when 'end'
-            curr.delete("#{type}/#{spec}") or
-              error "end before begin: #{type}/#{spec}"
-          else
-            raise 'must not happen'
-          end
-
-        when %r{(?:\A\#@|\#@@)([a-z]+)/(\w+)\{}
-          type = check_type($1)
-          spec = check_spec($2)
-          key = "#{type}/#{spec}"
-          if curr[key]
-            error "begin x2: #{key}"
-          end
-          (repo[type] ||= {})[spec] = curr[key] = []
-          opened.push([type, spec])
-
-        when %r{(?:\A\#@|\#@@)([a-z]+)/(\w+)\}}
-          type = check_type($1)
-          spec = check_spec($2)
-          curr.delete("#{type}/#{spec}") or
-            error "end before begin: #{type}/#{spec}"
-          opened.delete("#{type}/#{spec}")
-
-        when /(?:\A\#@|\#@@)\}/
-          type, spec = opened.last
-          curr.delete("#{type}/#{spec}") or
-            error "closed before open: #{type}/#{spec}"
-          opened.pop
-
-        when /(?:\A\#@|\#@@)yacchack/
-          yacchack = true
-
-        when /\A\#@-/ # does not increment line number.
-          line = canonical($')
-          curr.each_value { |list| list.push(Line.new(nil, line)) }
-
-        else
-          next if yacchack && (line.strip == ';')
-
-          line = canonical(line)
-          curr.each_value { |list| list.push(Line.new(lineno, line)) }
-          lineno += 1
-        end
-      end
-      if curr.size > 1
-        curr.delete('WHOLE')
-        curr.each { |range, lines| @logger.warn "#{filename}: unclosed range: #{range} (begin @#{lines.first.number})" }
-        raise ApplicationError, 'ERROR'
-      end
-
-      repo
-    end
-
-    def canonical(line)
-      if @leave_content
-        return line
-      end
-
-      tabwidth = @config['tabwidth'] || 8
-      if tabwidth > 0
-        detab(line, tabwidth).rstrip + "\n"
-      else
-        line
-      end
+    def location
+      "#{filename}:#{lineno}"
     end
 
-    def check_type(type)
-      error "wrong type: #{type.inspect}" unless Preprocessor::TYPES.index(type)
-      type
+    def filename
+      @inf.path
     end
 
-    def check_spec(spec)
-      error "wrong spec: #{spec.inspect}" unless /\A\w+\z/ =~ spec
-      spec
+    def lineno
+      @inf.lineno
     end
   end
 end