review 5.1.1 → 5.2.0

data/lib/review/compiler.rb

@@ -10,10 +10,13 @@ require 'review/extentions'
 require 'review/preprocessor'
 require 'review/exception'
 require 'review/location'
+require 'review/loggable'
 require 'strscan'
 
 module ReVIEW
   class Compiler
+    include Loggable
+
     MAX_HEADLINE_LEVEL = 6
 
     def initialize(builder)
@@ -24,6 +27,12 @@ module ReVIEW
 
       ## to decide escaping/non-escaping for text
       @command_name_stack = []
+
+      @logger = ReVIEW.logger
+
+      @ignore_errors = builder.is_a?(ReVIEW::IndexBuilder)
+
+      @compile_errors = nil
     end
 
     attr_reader :builder, :previous_list_type
@@ -44,6 +53,10 @@ module ReVIEW
     def compile(chap)
       @chapter = chap
       do_compile
+      if @compile_errors
+        raise ApplicationError, "#{location.filename} cannot be compiled."
+      end
+
       @builder.result
     end
 
@@ -261,6 +274,7 @@ module ReVIEW
     def do_compile
       f = LineInput.new(StringIO.new(@chapter.content))
       @builder.bind(self, @chapter, Location.new(@chapter.basename, f))
+      @previous_list_type = nil
 
       ## in minicolumn, such as note/info/alert...
       @minicolumn_name = nil
@@ -272,27 +286,27 @@ module ReVIEW
           f.gets # Nothing to do
         when /\A=+[\[\s{]/
           compile_headline(f.gets)
-          @builder.previous_list_type = nil
+          @previous_list_type = nil
         when /\A\s+\*/
           compile_ulist(f)
-          @builder.previous_list_type = 'ul'
+          @previous_list_type = 'ul'
         when /\A\s+\d+\./
           compile_olist(f)
-          @builder.previous_list_type = 'ol'
+          @previous_list_type = 'ol'
         when /\A\s+:\s/
           compile_dlist(f)
-          @builder.previous_list_type = 'dl'
+          @previous_list_type = 'dl'
         when /\A\s*:\s/
-          warn 'Definition list starting with `:` is deprecated. It should start with ` : `.'
+          warn 'Definition list starting with `:` is deprecated. It should start with ` : `.', location: location
           compile_dlist(f)
-          @builder.previous_list_type = 'dl'
+          @previous_list_type = 'dl'
         when %r{\A//\}}
           if in_minicolumn?
             _line = f.gets
             compile_minicolumn_end
           else
             f.gets
-            error 'block end seen but not opened'
+            error 'block end seen but not opened', location: location
           end
         when %r{\A//[a-z]+}
           line = f.peek
@@ -307,45 +321,44 @@ module ReVIEW
             name, args, lines = read_command(f)
             syntax = syntax_descriptor(name)
             unless syntax
-              error "unknown command: //#{name}"
-              compile_unknown_command(args, lines)
+              error "unknown command: //#{name}", location: location
               @command_name_stack.pop
               next
             end
             compile_command(syntax, args, lines)
             @command_name_stack.pop
           end
-          @builder.previous_list_type = nil
+          @previous_list_type = nil
         when %r{\A//}
           line = f.gets
-          warn "`//' seen but is not valid command: #{line.strip.inspect}"
+          warn "`//' seen but is not valid command: #{line.strip.inspect}", location: location
           if block_open?(line)
-            warn 'skipping block...'
+            warn 'skipping block...', location: location
             read_block(f, false)
           end
-          @builder.previous_list_type = nil
+          @previous_list_type = nil
         else
           if f.peek.strip.empty?
             f.gets
             next
           end
           compile_paragraph(f)
-          @builder.previous_list_type = nil
+          @previous_list_type = nil
         end
       end
       close_all_tagged_section
     rescue SyntaxError => e
-      error e
+      error e, location: location
     end
 
     def compile_minicolumn_begin(name, caption = nil)
       mid = "#{name}_begin"
       unless @builder.respond_to?(mid)
-        error "strategy does not support minicolumn: #{name}"
+        error "strategy does not support minicolumn: #{name}", location: location
       end
 
       if @minicolumn_name
-        error "minicolumn cannot be nested: #{name}"
+        error "minicolumn cannot be nested: #{name}", location: location
         return
       end
       @minicolumn_name = name
@@ -355,7 +368,7 @@ module ReVIEW
 
     def compile_minicolumn_end
       unless @minicolumn_name
-        error "minicolumn is not used: #{name}"
+        error "minicolumn is not used: #{name}", location: location
         return
       end
       name = @minicolumn_name
@@ -382,19 +395,19 @@ module ReVIEW
           open_tag = tag[1..-1]
           prev_tag_info = @tagged_section.pop
           if prev_tag_info.nil? || prev_tag_info.first != open_tag
-            error "#{open_tag} is not opened."
+            error "#{open_tag} is not opened.", location: location
           end
           close_tagged_section(*prev_tag_info)
         else
           if caption.empty?
-            warn 'headline is empty.'
+            warn 'headline is empty.', location: location
           end
           close_current_tagged_section(level)
           open_tagged_section(tag, level, label, caption)
         end
       else
         if caption.empty?
-          warn 'headline is empty.'
+          warn 'headline is empty.', location: location
         end
         if @headline_indexs.size > (index + 1)
           @headline_indexs = @headline_indexs[0..index]
@@ -425,7 +438,7 @@ module ReVIEW
     def open_tagged_section(tag, level, label, caption)
       mid = "#{tag}_begin"
       unless @builder.respond_to?(mid)
-        error "builder does not support tagged section: #{tag}"
+        error "builder does not support tagged section: #{tag}", location: location
         headline(level, label, caption)
         return
       end
@@ -438,7 +451,7 @@ module ReVIEW
       if @builder.respond_to?(mid)
         @builder.__send__(mid, level)
       else
-        error "builder does not support block op: #{mid}"
+        error "builder does not support block op: #{mid}", location: location
       end
     end
 
@@ -467,7 +480,7 @@ module ReVIEW
         elsif level < current_level # down
           level_diff = current_level - level
           if level_diff != 1
-            error 'too many *.'
+            error 'too many *.', location: location
           end
           level = current_level
           @builder.ul_begin { level }
@@ -561,7 +574,7 @@ module ReVIEW
         end
       end
       unless f.peek.to_s.start_with?('//}')
-        error "unexpected EOF (block begins at: #{head})"
+        error "unexpected EOF (block begins at: #{head})", location: location
         return buf
       end
       f.gets # discard terminator
@@ -581,7 +594,7 @@ module ReVIEW
         words << w2
       end
       unless scanner.eos?
-        error "argument syntax error: #{scanner.rest} in #{str.inspect}"
+        error "argument syntax error: #{scanner.rest} in #{str.inspect}", location: location
         return []
       end
       words
@@ -589,37 +602,32 @@ module ReVIEW
 
     def compile_command(syntax, args, lines)
       unless @builder.respond_to?(syntax.name)
-        error "builder does not support command: //#{syntax.name}"
-        compile_unknown_command(args, lines)
+        error "builder does not support command: //#{syntax.name}", location: location
         return
       end
       begin
         syntax.check_args(args)
       rescue CompileError => e
-        error e.message
+        error e.message, location: location
         args = ['(NoArgument)'] * syntax.min_argc
       end
       if syntax.block_allowed?
         compile_block(syntax, args, lines)
       else
         if lines
-          error "block is not allowed for command //#{syntax.name}; ignore"
+          error "block is not allowed for command //#{syntax.name}; ignore", location: location
         end
         compile_single(syntax, args)
       end
     end
 
-    def compile_unknown_command(args, lines)
-      @builder.unknown_command(args, lines)
-    end
-
     def compile_block(syntax, args, lines)
       @builder.__send__(syntax.name, (lines || default_block(syntax)), *args)
     end
 
     def default_block(syntax)
       if syntax.block_required?
-        error "block is required for //#{syntax.name}; use empty block"
+        error "block is required for //#{syntax.name}; use empty block", location: location
       end
       []
     end
@@ -633,7 +641,7 @@ module ReVIEW
         op = $1
         arg = $3
         if arg =~ /[\x01\x02\x03\x04]/
-          error "invalid character in '#{str}'"
+          error "invalid character in '#{str}'", location: location
         end
         replaced = arg.tr('@', "\x01").tr('\\', "\x02").tr('{', "\x03").tr('}', "\x04")
         "@<#{op}>{#{replaced}}"
@@ -655,7 +663,7 @@ module ReVIEW
       words = replace_fence(str).split(/(@<\w+>\{(?:[^}\\]|\\.)*?\})/, -1)
       words.each do |w|
         if w.scan(/@<\w+>/).size > 1 && !/\A@<raw>/.match(w)
-          error "`@<xxx>' seen but is not valid inline op: #{w}"
+          error "`@<xxx>' seen but is not valid inline op: #{w}", location: location
         end
       end
       result = ''
@@ -671,7 +679,7 @@ module ReVIEW
       end
       result
     rescue => e
-      error e.message
+      error e.message, location: location
     end
     public :text # called from builder
 
@@ -686,7 +694,7 @@ module ReVIEW
 
       @builder.__send__("inline_#{op}", arg)
     rescue => e
-      error e.message
+      error e.message, location: location
       @builder.nofunc_text(str)
     end
 
@@ -698,12 +706,20 @@ module ReVIEW
       @builder.minicolumn_block_name?(name)
     end
 
-    def warn(msg)
-      @builder.warn msg
+    def ignore_errors?
+      @ignore_errors
     end
 
-    def error(msg)
-      @builder.error msg
+    def location
+      @builder.location
+    end
+
+    ## override
+    def error(msg, location: nil)
+      return if ignore_errors? # for IndexBuilder
+
+      @compile_errors = true
+      super
     end
   end
 end # module ReVIEW

data/lib/review/epubmaker.rb

@@ -27,10 +27,12 @@ require 'review/epubmaker/epubv2'
 require 'review/epubmaker/epubv3'
 require 'review/epubmaker/reviewheaderlistener'
 require 'review/makerhelper'
+require 'review/loggable'
 
 module ReVIEW
   class EPUBMaker
     include MakerHelper
+    include Loggable
     include ReVIEW::CallHook
 
     def initialize
@@ -42,19 +44,6 @@ module ReVIEW
       @basedir = nil
     end
 
-    def error(msg)
-      @logger.error msg
-      exit 1
-    end
-
-    def warn(msg)
-      @logger.warn msg
-    end
-
-    def log(msg)
-      @logger.debug(msg)
-    end
-
     def self.execute(*args)
       self.new.execute(*args)
     end
@@ -84,14 +73,14 @@ module ReVIEW
 
     def execute(*args)
       cmd_config, yamlfile, exportfile = parse_opts(args)
-      error "#{yamlfile} not found." unless File.exist?(yamlfile)
+      error! "#{yamlfile} not found." unless File.exist?(yamlfile)
 
       @config = ReVIEW::Configure.create(maker: 'epubmaker',
                                          yamlfile: yamlfile,
                                          config: cmd_config)
       @producer = ReVIEW::EPUBMaker::Producer.new(@config)
       update_log_level
-      log("Loaded yaml file (#{yamlfile}).")
+      debug("Loaded yaml file (#{yamlfile}).")
       @basedir = File.absolute_path(File.dirname(yamlfile))
 
       produce(yamlfile, exportfile)
@@ -129,12 +118,10 @@ module ReVIEW
       booktmpname = "#{bookname}-epub"
 
       @img_math = ReVIEW::ImgMath.new(@config)
-      begin
-        @config.check_version(ReVIEW::VERSION)
-      rescue ReVIEW::ConfigError => e
+      unless @config.check_version(ReVIEW::VERSION, exception: false)
         warn e.message
       end
-      log("#{bookname}.epub will be created.")
+      debug("#{bookname}.epub will be created.")
 
       FileUtils.rm_f("#{bookname}.epub")
       if @config['debug']
@@ -145,7 +132,7 @@ module ReVIEW
 
       basetmpdir = build_path
       begin
-        log("Created first temporary directory as #{basetmpdir}.")
+        debug("Created first temporary directory as #{basetmpdir}.")
 
         call_hook('hook_beforeprocess', basetmpdir, base_dir: @basedir)
 
@@ -192,14 +179,14 @@ module ReVIEW
           epubtmpdir = File.join(basetmpdir, booktmpname)
           Dir.mkdir(epubtmpdir)
         end
-        log('Call ePUB producer.')
+        debug('Call ePUB producer.')
         @producer.produce("#{bookname}.epub", basetmpdir, epubtmpdir, base_dir: @basedir)
-        log('Finished.')
+        debug('Finished.')
         @logger.success("built #{bookname}.epub")
       rescue ApplicationError => e
         raise if @config['debug']
 
-        error(e.message)
+        error! e.message
       ensure
         FileUtils.remove_entry_secure(basetmpdir) unless @config['debug']
       end
@@ -245,8 +232,8 @@ module ReVIEW
           end
           basedir = File.dirname(file)
           FileUtils.mkdir_p(File.join(destdir, basedir))
-          log("Copy #{file} to the temporary directory.")
-          FileUtils.cp(file, File.join(destdir, basedir))
+          debug("Copy #{file} to the temporary directory.")
+          FileUtils.cp(file, File.join(destdir, basedir), preserve: true)
         end
       else
         recursive_copy_files(resdir, destdir, allow_exts)
@@ -270,8 +257,8 @@ module ReVIEW
             recursive_copy_files(File.join(resdir, fname), File.join(destdir, fname), allow_exts)
           elsif fname =~ /\.(#{allow_exts.join('|')})\Z/i
             FileUtils.mkdir_p(destdir)
-            log("Copy #{resdir}/#{fname} to the temporary directory.")
-            FileUtils.cp(File.join(resdir, fname), destdir)
+            debug("Copy #{resdir}/#{fname} to the temporary directory.")
+            FileUtils.cp(File.join(resdir, fname), destdir, preserve: true)
           end
         end
       end
@@ -280,8 +267,7 @@ module ReVIEW
     def check_compile_status
       return unless @compile_errors
 
-      $stderr.puts 'compile error, No EPUB file output.'
-      exit 1
+      error! 'compile error, No EPUB file output.'
     end
 
     def build_body(basetmpdir, yamlfile)
@@ -323,7 +309,7 @@ module ReVIEW
     end
 
     def build_part(part, basetmpdir, htmlfile)
-      log("Create #{htmlfile} from a template.")
+      debug("Create #{htmlfile} from a template.")
       File.open(File.join(basetmpdir, htmlfile), 'w') do |f|
         @part_number = part.number
         @part_title = part.name.strip
@@ -384,7 +370,7 @@ module ReVIEW
 
       htmlfile = "#{id}.#{@config['htmlext']}"
       write_buildlogtxt(basetmpdir, htmlfile, filename)
-      log("Create #{htmlfile} from #{filename}.")
+      debug("Create #{htmlfile} from #{filename}.")
 
       if @config['params'].present?
         warn %Q('params:' in config.yml is obsoleted.)
@@ -398,8 +384,8 @@ module ReVIEW
         remove_hidden_title(basetmpdir, htmlfile)
       rescue => e
         @compile_errors = true
-        warn "compile error in #{filename} (#{e.class})"
-        warn e.message
+        error "compile error in #{filename} (#{e.class})"
+        error e.message
       end
     end
 
@@ -480,7 +466,7 @@ module ReVIEW
       @htmltoc.each_item do |level, file, title, args|
         next if level.to_i > @config['toclevel'] && args[:force_include].nil?
 
-        log("Push #{file} to ePUB contents.")
+        debug("Push #{file} to ePUB contents.")
 
         params = { file: file,
                    level: level.to_i,
@@ -504,9 +490,9 @@ module ReVIEW
 
       @config['stylesheet'].each do |sfile|
         unless File.exist?(sfile)
-          error "stylesheet: #{sfile} is not found."
+          error! "stylesheet: #{sfile} is not found."
         end
-        FileUtils.cp(sfile, basetmpdir)
+        FileUtils.cp(sfile, basetmpdir, preserve: true)
         @producer.contents.push(ReVIEW::EPUBMaker::Content.new(file: sfile))
       end
     end
@@ -514,10 +500,10 @@ module ReVIEW
     def copy_static_file(configname, destdir, destfilename: nil)
       destfilename ||= @config[configname]
       unless File.exist?(@config[configname])
-        error "#{configname}: #{@config[configname]} is not found."
+        error! "#{configname}: #{@config[configname]} is not found."
       end
       FileUtils.cp(@config[configname],
-                   File.join(destdir, destfilename))
+                   File.join(destdir, destfilename), preserve: true)
     end
 
     def copy_frontmatter(basetmpdir)