review 5.1.1 → 5.4.0

data/lib/review/compiler.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2009-2020 Minero Aoki, Kenshi Muto
+# Copyright (c) 2009-2021 Minero Aoki, Kenshi Muto
 # Copyright (c) 2002-2007 Minero Aoki
 #
 # This program is free software.
@@ -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
@@ -35,7 +44,7 @@ module ReVIEW
 
     def non_escaped_commands
       if @builder.highlight?
-        %i[list emlist listnum emlistnum cmd]
+        %i[list emlist listnum emlistnum cmd source]
       else
         []
       end
@@ -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
 
@@ -58,7 +71,7 @@ module ReVIEW
       attr_reader :name
 
       def check_args(args)
-        unless @argc_spec === args.size
+        unless @argc_spec === args.size # rubocop:disable Style/CaseEquality
           raise CompileError, "wrong # of parameters (block command //#{@name}, expect #{@argc_spec} but #{args.size})"
         end
 
@@ -183,6 +196,8 @@ module ReVIEW
     defminicolumn :notice, 0..1
 
     defsingle :footnote, 2
+    defsingle :endnote, 2
+    defsingle :printendnotes, 0
     defsingle :noindent, 0
     defsingle :blankline, 0
     defsingle :pagebreak, 0
@@ -207,6 +222,7 @@ module ReVIEW
     definline :table
     definline :eq
     definline :fn
+    definline :endnote
     definline :kw
     definline :ruby
     definline :bou
@@ -261,6 +277,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 +289,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 +324,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 +371,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 +398,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 +441,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 +454,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
 
@@ -451,7 +467,7 @@ module ReVIEW
     def compile_ulist(f)
       level = 0
       f.while_match(/\A\s+\*|\A\#@/) do |line|
-        next if line =~ /\A\#@/
+        next if /\A\#@/.match?(line)
 
         buf = [text(line.sub(/\*+/, '').strip)]
         f.while_match(/\A\s+(?!\*)\S/) do |cont|
@@ -467,7 +483,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 }
@@ -494,7 +510,7 @@ module ReVIEW
     def compile_olist(f)
       @builder.ol_begin
       f.while_match(/\A\s+\d+\.|\A\#@/) do |line|
-        next if line =~ /\A\#@/
+        next if /\A\#@/.match?(line)
 
         num = line.match(/(\d+)\./)[1]
         buf = [text(line.sub(/\d+\./, '').strip)]
@@ -556,12 +572,12 @@ module ReVIEW
       f.until_match(%r{\A//\}}) do |line|
         if ignore_inline
           buf.push(line.chomp)
-        elsif line !~ /\A\#@/
+        elsif !/\A\#@/.match?(line)
           buf.push(text(line.rstrip, true))
         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 +597,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 +605,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
@@ -632,8 +643,8 @@ module ReVIEW
       str.gsub(/@<(\w+)>([$|])(.+?)(\2)/) do
         op = $1
         arg = $3
-        if arg =~ /[\x01\x02\x03\x04]/
-          error "invalid character in '#{str}'"
+        if /[\x01\x02\x03\x04]/.match?(arg)
+          error "invalid character in '#{str}'", location: location
         end
         replaced = arg.tr('@', "\x01").tr('\\', "\x02").tr('{', "\x03").tr('}', "\x04")
         "@<#{op}>{#{replaced}}"
@@ -655,23 +666,23 @@ 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 = ''
       until words.empty?
-        if in_non_escaped_command? && block_mode
-          result << revert_replace_fence(words.shift)
-        else
-          result << @builder.nofunc_text(revert_replace_fence(words.shift))
-        end
+        result << if in_non_escaped_command? && block_mode
+                    revert_replace_fence(words.shift)
+                  else
+                    @builder.nofunc_text(revert_replace_fence(words.shift))
+                  end
         break if words.empty?
 
         result << compile_inline(revert_replace_fence(words.shift.gsub(/\\\}/, '}').gsub(/\\\\/, '\\')))
       end
       result
-    rescue => e
-      error e.message
+    rescue StandardError => e
+      error e.message, location: location
     end
     public :text # called from builder
 
@@ -685,8 +696,8 @@ module ReVIEW
       end
 
       @builder.__send__("inline_#{op}", arg)
-    rescue => e
-      error e.message
+    rescue StandardError => e
+      error e.message, location: location
       @builder.nofunc_text(str)
     end
 
@@ -698,12 +709,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/configure.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2012-2021 Masanori Kado, Masayoshi Takahashi, Kenshi Muto
+# Copyright (c) 2012-2022 Masanori Kado, Masayoshi Takahashi, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -141,6 +141,9 @@ module ReVIEW
           'force_include_images' => [],
           'cover_linear' => nil,
           'back_footnote' => nil
+        },
+        'textmaker' => {
+          'th_bold' => nil
         }
       ]
       conf.maker = nil
@@ -155,7 +158,7 @@ module ReVIEW
         begin
           loader = ReVIEW::YAMLLoader.new
           conf.deep_merge!(loader.load_file(yamlfile))
-        rescue => e
+        rescue StandardError => e
           raise ReVIEW::ConfigError, "yaml error #{e.message}"
         end
       end

data/lib/review/epub2html.rb

@@ -13,7 +13,7 @@ require 'review/version'
 
 begin
   require 'cgi/escape'
-rescue
+rescue StandardError
   require 'cgi/util'
 end
 
@@ -62,10 +62,10 @@ EOT
     def parse_epub(epubname)
       Zip::File.open(epubname) do |zio|
         zio.each do |entry|
-          if entry.name =~ /.+\.opf\Z/
+          if /.+\.opf\Z/.match?(entry.name)
             opf = entry.get_input_stream.read
             @opfxml = REXML::Document.new(opf)
-          elsif entry.name =~ /.+\.x?html\Z/
+          elsif /.+\.x?html\Z/.match?(entry.name)
             @htmls[entry.name.sub('OEBPS/', '')] = entry.get_input_stream.read.force_encoding('utf-8')
           end
         end
@@ -107,15 +107,15 @@ EOT
         end
 
         file, anc = href.split('#', 2)
-        if anc
-          if file.empty?
-            anc = "#{sanitize(fname)}_#{sanitize(anc)}"
-          else
-            anc = "#{sanitize(file)}_#{sanitize(anc)}"
-          end
-        else
-          anc = sanitize(file)
-        end
+        anc = if anc
+                if file.empty?
+                  "#{sanitize(fname)}_#{sanitize(anc)}"
+                else
+                  "#{sanitize(file)}_#{sanitize(anc)}"
+                end
+              else
+                sanitize(file)
+              end
 
         e.attributes['href'] = "##{anc}"
       end

data/lib/review/epubmaker/content.rb

@@ -76,7 +76,7 @@ module ReVIEW
         if @id.nil?
           @id = @file.gsub(%r{[\\/. ]}, '-')
         end
-        if @id =~ /\A[^a-z]/i
+        if /\A[^a-z]/i.match?(@id)
           @id = "rv-#{@id}"
         end
         @id = CGI.escape(@id).gsub('%', '_25_')

data/lib/review/epubmaker/epubcommon.rb

@@ -1,6 +1,6 @@
 # = epubcommon.rb -- super class for EPUBv2 and EPUBv3
 #
-# Copyright (c) 2010-2019 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
@@ -27,6 +27,7 @@ module ReVIEW
         @contents = producer.contents
         @body_ext = nil
         @logger = ReVIEW.logger
+        @workdir = nil
       end
 
       attr_reader :config
@@ -36,7 +37,8 @@ module ReVIEW
         CGI.escapeHTML(str)
       end
 
-      def produce(epubfile, basedir, tmpdir)
+      def produce(_epubfile, _basedir, _tmpdir, base_dir:)
+        @workdir = base_dir
         raise NotImplementedError # should be overridden
       end
 
@@ -70,7 +72,7 @@ module ReVIEW
           item = contents.find { |content| content.coverimage?(config['coverimage']) }
 
           unless item
-            raise "coverimage #{config['coverimage']} not found. Abort."
+            raise ApplicationError, "coverimage #{config['coverimage']} not found. Abort."
           end
 
           %Q(    <meta name="cover" content="#{item.id}"/>\n)
@@ -99,27 +101,43 @@ module ReVIEW
         end
       end
 
+      def template_name(localfile: 'layout.html.erb', systemfile: nil)
+        if @workdir
+          layoutfile = File.join(@workdir, 'layouts', localfile)
+          if File.exist?(layoutfile)
+            return layoutfile
+          end
+        end
+
+        if systemfile
+          return systemfile
+        end
+
+        if config['htmlversion'].to_i == 5
+          './html/layout-html5.html.erb'
+        else
+          './html/layout-xhtml1.html.erb'
+        end
+      end
+
       # Return cover content.
       # If Producer#config["coverimage"] is defined, it will be used for
       # the cover image.
       def cover
-        @body_ext = config['epubversion'] >= 3 ? %Q( epub:type="cover") : ''
+        @body_ext = config['epubversion'] >= 3 ? %Q( epub:type="cover") : nil
 
         if config['coverimage']
           @coverimage_src = coverimage
-          raise "coverimage #{config['coverimage']} not found. Abort." unless @coverimage_src
+          raise ApplicationError, "coverimage #{config['coverimage']} not found. Abort." unless @coverimage_src
         end
-        @body = ReVIEW::Template.generate(path: './html/_cover.html.erb', binding: binding)
+        @body = ReVIEW::Template.generate(path: template_name(localfile: '_cover.html.erb', systemfile: 'html/_cover.html.erb'), binding: binding)
 
         @title = h(config.name_of('title'))
         @language = config['language']
         @stylesheets = config['stylesheet']
-        template_path = if config['htmlversion'].to_i == 5
-                          './html/layout-html5.html.erb'
-                        else
-                          './html/layout-xhtml1.html.erb'
-                        end
-        ReVIEW::Template.generate(path: template_path, binding: binding)
+        ret = ReVIEW::Template.generate(path: template_name, binding: binding)
+        @body_ext = nil
+        ret
       end
 
       # Return title (copying) content.
@@ -138,16 +156,11 @@ module ReVIEW
         if config.names_of('pbl')
           @publisher_str = join_with_separator(config.names_of('pbl'), ReVIEW::I18n.t('names_splitter'))
         end
-        @body = ReVIEW::Template.generate(path: './html/_titlepage.html.erb', binding: binding)
+        @body = ReVIEW::Template.generate(path: template_name(localfile: '_titlepage.html.erb', systemfile: './html/_titlepage.html.erb'), binding: binding)
 
         @language = config['language']
         @stylesheets = config['stylesheet']
-        template_path = if config['htmlversion'].to_i == 5
-                          './html/layout-html5.html.erb'
-                        else
-                          './html/layout-xhtml1.html.erb'
-                        end
-        ReVIEW::Template.generate(path: template_path, binding: binding)
+        ReVIEW::Template.generate(path: template_name, binding: binding)
       end
 
       # Return colophon content.
@@ -155,24 +168,19 @@ module ReVIEW
         @title = h(ReVIEW::I18n.t('colophontitle'))
         @isbn_hyphen = isbn_hyphen
 
-        @body = ReVIEW::Template.generate(path: './html/_colophon.html.erb', binding: binding)
+        @body = ReVIEW::Template.generate(path: template_name(localfile: '_colophon.html.erb', systemfile: './html/_colophon.html.erb'), binding: binding)
 
         @language = config['language']
         @stylesheets = config['stylesheet']
-        template_path = if config['htmlversion'].to_i == 5
-                          './html/layout-html5.html.erb'
-                        else
-                          './html/layout-xhtml1.html.erb'
-                        end
-        ReVIEW::Template.generate(path: template_path, binding: binding)
+        ReVIEW::Template.generate(path: template_name, binding: binding)
       end
 
       def isbn_hyphen
         str = config['isbn'].to_s
 
-        if str =~ /\A\d{10}\Z/
+        if /\A\d{10}\Z/.match?(str)
           "#{str[0..0]}-#{str[1..5]}-#{str[6..8]}-#{str[9..9]}"
-        elsif str =~ /\A\d{13}\Z/
+        elsif /\A\d{13}\Z/.match?(str)
           "#{str[0..2]}-#{str[3..3]}-#{str[4..8]}-#{str[9..11]}-#{str[12..12]}"
         end
       end
@@ -184,9 +192,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)
                 @col_history << 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　](.+)/) do |m|
                   @col_history << ReVIEW::I18n.t('published_by3', [date_to_s(m[1]), m[2]])
@@ -199,7 +207,7 @@ module ReVIEW
           end
         end
 
-        ReVIEW::Template.generate(path: './html/_colophon_history.html.erb', binding: binding)
+        ReVIEW::Template.generate(path: template_name(localfile: '_colophon_history.html.erb', systemfile: './html/_colophon_history.html.erb'), binding: binding)
       end
 
       def date_to_s(date)
@@ -211,22 +219,16 @@ module ReVIEW
       # Return own toc content.
       def mytoc
         @title = h(ReVIEW::I18n.t('toctitle'))
-
         @body = %Q(  <h1 class="toc-title">#{h(ReVIEW::I18n.t('toctitle'))}</h1>\n)
-        if config['epubmaker']['flattoc'].nil?
-          @body << hierarchy_ncx('ul')
-        else
-          @body << flat_ncx('ul', config['epubmaker']['flattocindent'])
-        end
+        @body << if config['epubmaker']['flattoc'].nil?
+                   hierarchy_ncx('ul')
+                 else
+                   flat_ncx('ul', config['epubmaker']['flattocindent'])
+                 end
 
         @language = config['language']
         @stylesheets = config['stylesheet']
-        template_path = if config['htmlversion'].to_i == 5
-                          './html/layout-html5.html.erb'
-                        else
-                          './html/layout-xhtml1.html.erb'
-                        end
-        ReVIEW::Template.generate(path: template_path, binding: binding)
+        ReVIEW::Template.generate(path: template_name, binding: binding)
       end
 
       def hierarchy_ncx(type)
@@ -334,11 +336,11 @@ module ReVIEW
         end
 
         contents.each do |item|
-          next if item.file =~ /#/ # skip subgroup
+          next if /#/.match?(item.file) # skip subgroup
 
           fname = "#{basedir}/#{item.file}"
           unless File.exist?(fname)
-            raise "#{fname} is not found."
+            raise ApplicationError, "#{fname} is not found."
           end
 
           FileUtils.mkdir_p(File.dirname("#{tmpdir}/OEBPS/#{item.file}"))

data/lib/review/epubmaker/epubv2.rb

@@ -1,6 +1,6 @@
 # = epubv2.rb -- EPUB version 2 producer.
 #
-# Copyright (c) 2010-2017 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
@@ -159,6 +159,7 @@ EOT
       # +basedir+ points the directory has contents.
       # +tmpdir+ defines temporary directory.
       def produce(epubfile, work_dir, tmpdir, base_dir:)
+        @workdir = base_dir
         produce_write_common(work_dir, tmpdir)
 
         ncx_file = "#{tmpdir}/OEBPS/#{config['bookname']}.ncx"