review 5.1.1 → 5.2.0

data/lib/review/epubmaker/producer.rb

@@ -25,11 +25,14 @@ require 'review/epubmaker/epubv3'
 require 'review/i18n'
 require 'review/configure'
 require 'review/extentions/hash'
+require 'review/loggable'
 
 module ReVIEW
   class EPUBMaker
     # EPUBMaker produces EPUB file.
     class Producer
+      include Loggable
+
       # Array of content objects.
       attr_accessor :contents
       # Parameter hash.
@@ -37,10 +40,6 @@ module ReVIEW
       # Message resource object.
       attr_reader :res
 
-      def warn(msg)
-        @logger.warn(msg)
-      end
-
       # Construct producer object.
       # +config+ takes initial parameter hash.
       def initialize(config)

data/lib/review/exception.rb

@@ -22,4 +22,11 @@ module ReVIEW
   class FileNotFound < ApplicationError; end
 
   class KeyError < CompileError; end
+
+  class BuildError < ApplicationError
+    def initialize(msg, location: nil)
+      @location = location
+      super(msg)
+    end
+  end
 end

data/lib/review/htmlbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto, Masayoshi Takahashi,
+# Copyright (c) 2008-2021 Minero Aoki, Kenshi Muto, Masayoshi Takahashi,
 #                         KADO Masanori
 #               2002-2007 Minero Aoki
 #
@@ -42,18 +42,20 @@ module ReVIEW
     end
 
     def builder_init_file
+      super
       @noindent = nil
       @ol_num = nil
-      @warns = []
-      @errors = []
       @chapter.book.image_types = %w[.png .jpg .jpeg .gif .svg]
       @column = 0
-      @sec_counter = SecCounter.new(5, @chapter)
       @nonum_counter = 0
       @first_line_num = nil
       @body_ext = nil
       @toc = nil
       @javascripts = []
+      @section_stack = []
+
+      maker = @book.config.maker || 'epubmaker' # for review-compile
+      @use_section = @book.config[maker] && @book.config[maker]['use_section']
     end
     private :builder_init_file
 
@@ -78,7 +80,7 @@ module ReVIEW
 
       if File.exist?(layout_file)
         if ENV['REVIEW_SAFE_MODE'].to_i & 4 > 0
-          warn %Q(user's layout is prohibited in safe mode. ignored.)
+          warn %Q(user's layout is prohibited in safe mode. ignored.), location: location
           layout_file = File.expand_path(htmlfilename, ReVIEW::Template::TEMPLATE_DIR)
         end
       else
@@ -87,7 +89,33 @@ module ReVIEW
       layout_file
     end
 
+    def use_section?
+      @use_section
+    end
+
+    def open_section(level)
+      result = []
+
+      while @section_stack.size > 0 && level <= @section_stack[-1]
+        result << '</section>'
+        @section_stack.pop
+      end
+      @section_stack.push(level)
+      result << %Q(<section class="level#{level}">)
+
+      return result.join("\n")
+    end
+
+    def close_sections
+      "</section>\n" * @section_stack.size
+    end
+
     def result
+      # flush all `</section>`
+      if use_section?
+        print close_sections
+      end
+
       # default XHTML header/footer
       @title = strip_html(compile_inline(@chapter.title))
       @body = solve_nest(@output.string)
@@ -133,6 +161,9 @@ module ReVIEW
     end
 
     def headline(level, label, caption)
+      if use_section?
+        print open_section(level)
+      end
       prefix, anchor = headline_prefix(level)
       if prefix
         prefix = %Q(<span class="secno">#{prefix}</span>)
@@ -618,7 +649,7 @@ module ReVIEW
           require 'math_ml'
           require 'math_ml/symbol/character_reference'
         rescue LoadError
-          error 'not found math_ml'
+          app_error 'not found math_ml'
         end
         p = MathML::LaTeX::Parser.new(symbol: MathML::Symbol::CharacterReference)
         print p.parse(lines.join("\n") + "\n", true)
@@ -676,7 +707,7 @@ module ReVIEW
     end
 
     def image_dummy(id, caption, lines)
-      warn "image not bound: #{id}"
+      warn "image not bound: #{id}", location: location
       puts %Q(<div id="#{normalize_id(id)}" class="image">)
       image_header(id, caption) if caption_top?('image')
       puts %Q(<pre class="dummyimage">)
@@ -740,7 +771,7 @@ module ReVIEW
 
     def imgtable(lines, id, caption = nil, metric = nil)
       unless @chapter.image_bound?(id)
-        warn "image not bound: #{id}"
+        warn "image not bound: #{id}", location: location
         image_dummy(id, caption, lines)
         return
       end
@@ -757,7 +788,7 @@ module ReVIEW
           table_header(id, caption)
         end
       rescue KeyError
-        error "no such table: #{id}"
+        app_error "no such table: #{id}"
       end
 
       puts '</div>'
@@ -813,7 +844,7 @@ EOS
       begin
         puts %Q(<img src="#{@chapter.image(id).path.sub(%r{\A\./}, '')}" alt="#{escape(compile_inline(caption))}"#{metrics} />)
       rescue
-        warn "image not bound: #{id}"
+        warn "image not bound: #{id}", location: location
         if lines
           puts %Q(<pre class="dummyimage">)
           lines.each do |line|
@@ -866,7 +897,7 @@ EOS
     alias_method :inline_ref, :inline_labelref
 
     def inline_pageref(id)
-      error "pageref op is unsupported on this builder: #{id}"
+      app_error "pageref op is unsupported on this builder: #{id}"
     end
 
     def inline_chapref(id)
@@ -877,7 +908,7 @@ EOS
         title
       end
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
     end
 
     def inline_chap(id)
@@ -887,7 +918,7 @@ EOS
         @book.chapter_index.number(id)
       end
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
     end
 
     def inline_title(id)
@@ -898,7 +929,7 @@ EOS
         title
       end
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
     end
 
     def inline_fn(id)
@@ -908,7 +939,7 @@ EOS
         %Q(<a id="fnb-#{normalize_id(id)}" href="#fn-#{normalize_id(id)}" class="noteref">*#{@chapter.footnote(id).number}</a>)
       end
     rescue KeyError
-      error "unknown footnote: #{id}"
+      app_error "unknown footnote: #{id}"
     end
 
     def compile_ruby(base, ruby)
@@ -990,7 +1021,7 @@ EOS
           require 'math_ml'
           require 'math_ml/symbol/character_reference'
         rescue LoadError
-          error 'not found math_ml'
+          app_error 'not found math_ml'
         end
         parser = MathML::LaTeX::Parser.new(symbol: MathML::Symbol::CharacterReference)
         %Q(<span class="equation">#{parser.parse(str, nil)}</span>)
@@ -1036,7 +1067,7 @@ EOS
     def inline_bib(id)
       %Q(<a href="#{@book.bib_file.gsub(/\.re\Z/, ".#{@book.config['htmlext']}")}#bib-#{normalize_id(id)}">[#{@chapter.bibpaper(id).number}]</a>)
     rescue KeyError
-      error "unknown bib: #{id}"
+      app_error "unknown bib: #{id}"
     end
 
     def inline_hd_chap(chap, id)
@@ -1053,7 +1084,7 @@ EOS
         str
       end
     rescue KeyError
-      error "unknown headline: #{id}"
+      app_error "unknown headline: #{id}"
     end
 
     def column_label(id, chapter = @chapter)
@@ -1069,7 +1100,7 @@ EOS
         I18n.t('column', compile_inline(chapter.column(id).caption))
       end
     rescue KeyError
-      error "unknown column: #{id}"
+      app_error "unknown column: #{id}"
     end
 
     def inline_list(id)
@@ -1196,7 +1227,7 @@ EOS
       begin
         %Q(<img src="#{@chapter.image(id).path.sub(%r{\A\./}, '')}" alt="[#{id}]" />)
       rescue
-        warn "image not bound: #{id}"
+        warn "image not bound: #{id}", location: location
         %Q(<pre>missing image: #{id}</pre>)
       end
     end

data/lib/review/idgxmlbuilder.rb

@@ -47,6 +47,7 @@ module ReVIEW
     end
 
     def builder_init_file
+      super
       @warns = []
       @errors = []
       @section = 0
@@ -200,7 +201,7 @@ module ReVIEW
 
     def ol_begin
       puts '<ol>'
-      @ol_num ||= 1
+      @ol_num ||= 1 # rubocop:disable Naming/MemoizedInstanceVariableName
     end
 
     def ol_item(lines, num)
@@ -265,7 +266,7 @@ module ReVIEW
         I18n.t('column', compile_inline(chapter.column(id).caption))
       end
     rescue KeyError
-      error "unknown column: #{id}"
+      app_error "unknown column: #{id}"
     end
 
     def inline_list(id)
@@ -436,7 +437,7 @@ module ReVIEW
       print '</pre>'
       image_header(id, caption) unless caption_top?('image')
       puts '</img>'
-      warn "image not bound: #{id}"
+      warn "image not bound: #{id}", location: location
     end
 
     def image_header(id, caption)
@@ -502,7 +503,7 @@ module ReVIEW
           table_header(id, caption)
         end
       rescue KeyError
-        error "no such table: #{id}"
+        app_error "no such table: #{id}"
       end
       puts '</table>'
       @tsize = nil
@@ -524,7 +525,7 @@ module ReVIEW
         col2 = rows[rows.length - 1].split(table_row_separator_regexp).length
         @col = col2 if col2 > @col
       end
-      error 'no rows in the table' if rows.empty?
+      app_error 'no rows in the table' if rows.empty?
       [sepidx, rows]
     end
 
@@ -539,11 +540,11 @@ module ReVIEW
           cellwidth.size.times do |n|
             cellwidth[n] = cellwidth[n].to_f / @book.config['pt_to_mm_unit'].to_f
             totallength += cellwidth[n]
-            warn "total length exceeds limit for table: #{@table_id}" if totallength > @tablewidth
+            warn "total length exceeds limit for table: #{@table_id}", location: location if totallength > @tablewidth
           end
           if cellwidth.size < @col
             cw = (@tablewidth - totallength) / (@col - cellwidth.size)
-            warn "auto cell sizing exceeds limit for table: #{@table_id}" if cw <= 0
+            warn "auto cell sizing exceeds limit for table: #{@table_id}", location: location if cw <= 0
             (cellwidth.size..(@col - 1)).each { |i| cellwidth[i] = cw }
           end
         end
@@ -627,7 +628,7 @@ module ReVIEW
         end
         puts '</table>'
       else
-        warn "image not bound: #{id}" if @strict
+        warn "image not bound: #{id}", location: location if @strict
         image_dummy(id, caption, lines)
       end
     end
@@ -656,7 +657,7 @@ module ReVIEW
     def inline_fn(id)
       %Q(<footnote>#{compile_inline(@chapter.footnote(id).content.strip)}</footnote>)
     rescue KeyError
-      error "unknown footnote: #{id}"
+      app_error "unknown footnote: #{id}"
     end
 
     def compile_ruby(base, ruby)
@@ -718,7 +719,7 @@ module ReVIEW
           sprintf('&#x%x;', 9392 + str[0] - 65)
         end
       else
-        error "can't parse maru: #{str}"
+        app_error "can't parse maru: #{str}"
       end
     end
 
@@ -780,7 +781,7 @@ module ReVIEW
       begin
         %Q(<Image href="file://#{@chapter.image(id).path.sub(%r{\A\./}, '')}" type="inline" />)
       rescue
-        warn "image not bound: #{id}"
+        warn "image not bound: #{id}", location: location
         ''
       end
     end
@@ -1127,7 +1128,7 @@ module ReVIEW
       begin
         puts %Q(<Image href="file://#{@chapter.image(id).path.sub(%r{\A\./}, '')}"#{metrics} />)
       rescue
-        warn %Q(image not bound: #{id})
+        warn %Q(image not bound: #{id}), location: location
       end
       unless caption_top?('image')
         puts %Q(<caption>#{compile_inline(caption)}</caption>) if caption.present?
@@ -1188,7 +1189,7 @@ module ReVIEW
           if chs2.size == 3
             chs = chs2
           else
-            error '--chapsplitter must have exactly 3 parameters with comma.'
+            app_error '--chapsplitter must have exactly 3 parameters with comma.'
           end
         end
         s = "#{chs[0]}#{@book.chapter_index.number(id)}#{chs[1]}#{@book.chapter_index.title(id)}#{chs[2]}"
@@ -1206,7 +1207,7 @@ module ReVIEW
         end
       end
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
     end
 
     def inline_chap(id)
@@ -1216,7 +1217,7 @@ module ReVIEW
         @book.chapter_index.number(id)
       end
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
     end
 
     def inline_title(id)
@@ -1227,7 +1228,7 @@ module ReVIEW
         title
       end
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
     end
 
     def source(lines, caption = nil, lang = nil)
@@ -1270,7 +1271,7 @@ module ReVIEW
     def inline_bib(id)
       %Q(<span type='bibref' idref='#{id}'>[#{@chapter.bibpaper(id).number}]</span>)
     rescue KeyError
-      error "unknown bib: #{id}"
+      app_error "unknown bib: #{id}"
     end
 
     def inline_hd_chap(chap, id)
@@ -1281,7 +1282,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 inline_recipe(id)

data/lib/review/idgxmlmaker.rb

@@ -16,10 +16,12 @@ require 'review/yamlloader'
 require 'review/idgxmlbuilder'
 require 'review/version'
 require 'review/makerhelper'
+require 'review/loggable'
 
 module ReVIEW
   class IDGXMLMaker
     include MakerHelper
+    include Loggable
 
     attr_accessor :config, :basedir
 
@@ -27,15 +29,7 @@ module ReVIEW
       @basedir = nil
       @logger = ReVIEW.logger
       @plaintext = nil
-    end
-
-    def error(msg)
-      @logger.error "#{File.basename($PROGRAM_NAME, '.*')}: #{msg}"
-      exit 1
-    end
-
-    def warn(msg)
-      @logger.warn "#{File.basename($PROGRAM_NAME, '.*')}: #{msg}"
+      @compile_errors = nil
     end
 
     def self.execute(*args)
@@ -78,7 +72,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: 'idgxmlmaker',
                                          yamlfile: yamlfile,
@@ -90,7 +84,7 @@ module ReVIEW
       rescue ApplicationError => e
         raise if @config['debug']
 
-        error(e.message)
+        error! e.message
       end
     end
 
@@ -106,6 +100,10 @@ module ReVIEW
       end
 
       build_body(@path, yamlfile)
+
+      if @compile_errors
+        app_error 'compile error, No IDGXML file output.'
+      end
     end
 
     def apply_filter(xmlfile)
@@ -180,8 +178,9 @@ module ReVIEW
         @converter.convert(filename, File.join(basetmpdir, xmlfile))
         apply_filter(File.join(basetmpdir, xmlfile))
       rescue => e
-        warn "compile error in #{filename} (#{e.class})"
-        warn e.message
+        @compile_errors = true
+        error "compile error in #{filename} (#{e.class})"
+        error e.message
       end
     end
   end