review 5.3.0 → 5.4.0

data/lib/review/epubmaker/epubcommon.rb

@@ -1,6 +1,6 @@
 # = epubcommon.rb -- super class for EPUBv2 and EPUBv3
 #
-# 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
@@ -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
 
@@ -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 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,7 +336,7 @@ 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)

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"

data/lib/review/epubmaker/epubv3.rb

@@ -1,6 +1,6 @@
 # = epubv3.rb -- EPUB version 3 producer.
 #
-# Copyright (c) 2010-2017 Kenshi Muto
+# Copyright (c) 2010-2022 Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -186,7 +186,7 @@ module ReVIEW
         @tocx_contents = []
         toc = nil
         contents.each do |item|
-          next if item.media !~ /xhtml\+xml/ # skip non XHTML
+          next unless /xhtml\+xml/.match?(item.media) # skip non XHTML
 
           @tocx_contents << item
         end
@@ -210,19 +210,20 @@ module ReVIEW
         @title = h(ReVIEW::I18n.t('toctitle'))
         @language = config['language']
         @stylesheets = config['stylesheet']
-        ReVIEW::Template.generate(path: './html/layout-html5.html.erb', binding: binding)
+        ReVIEW::Template.generate(path: template_name, binding: binding)
       end
 
       # Produce EPUB file +epubfile+.
       # +work_dir+ 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)
 
         toc_file = "#{tmpdir}/OEBPS/#{config['bookname']}-toc.#{config['htmlext']}"
         File.write(toc_file, ncx(config['epubmaker']['ncxindent']))
 
-        call_hook('hook_prepack', tmpdir, base_dir: base_dir)
+        call_hook('hook_prepack', tmpdir, base_dir: @workdir)
         expoter = ReVIEW::EPUBMaker::ZipExporter.new(tmpdir, config)
         expoter.export_zip(epubfile)
       end

data/lib/review/epubmaker/producer.rb

@@ -89,8 +89,8 @@ module ReVIEW
         Dir.foreach(path) do |f|
           next if f.start_with?('.')
 
-          if f =~ /\.(#{allow_exts.join('|')})\Z/i
-            path.chop! if path =~ %r{/\Z}
+          if /\.(#{allow_exts.join('|')})\Z/i.match?(f)
+            path.chop! if %r{/\Z}.match?(path)
             if base.nil?
               @contents.push(ReVIEW::EPUBMaker::Content.new(file: "#{path}/#{f}"))
             else
@@ -115,7 +115,7 @@ module ReVIEW
 
         # use Dir to solve a path for Windows (see #1011)
         new_tmpdir = Dir[File.join(tmpdir.nil? ? Dir.mktmpdir : tmpdir)][0]
-        if epubfile !~ %r{\A/}
+        unless epubfile.start_with?('/')
           epubfile = "#{current}/#{epubfile}"
         end
 

data/lib/review/epubmaker/reviewheaderlistener.rb

@@ -41,7 +41,7 @@ module ReVIEW
       end
 
       def tag_end(name)
-        if name =~ /\Ah\d+/
+        if /\Ah\d+/.match?(name)
           if @id.present?
             @headlines.push({ 'level' => @level,
                               'id' => @id,

data/lib/review/epubmaker.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
@@ -75,9 +75,13 @@ module ReVIEW
       cmd_config, yamlfile, exportfile = parse_opts(args)
       error! "#{yamlfile} not found." unless File.exist?(yamlfile)
 
-      @config = ReVIEW::Configure.create(maker: 'epubmaker',
-                                         yamlfile: yamlfile,
-                                         config: cmd_config)
+      begin
+        @config = ReVIEW::Configure.create(maker: 'epubmaker',
+                                           yamlfile: yamlfile,
+                                           config: cmd_config)
+      rescue ReVIEW::ConfigError => e
+        error! e.message
+      end
       @producer = ReVIEW::EPUBMaker::Producer.new(@config)
       update_log_level
       debug("Loaded yaml file (#{yamlfile}).")
@@ -227,7 +231,7 @@ module ReVIEW
       if @config['epubmaker']['verify_target_images'].present?
         @config['epubmaker']['force_include_images'].each do |file|
           unless File.exist?(file)
-            if file !~ /\Ahttps?:/
+            unless /\Ahttps?:/.match?(file)
               warn "#{file} is not found, skip."
             end
             next
@@ -257,7 +261,7 @@ module ReVIEW
 
           if FileTest.directory?(File.join(resdir, fname))
             recursive_copy_files(File.join(resdir, fname), File.join(destdir, fname), allow_exts)
-          elsif fname =~ /\.(#{allow_exts.join('|')})\Z/i
+          elsif /\.(#{allow_exts.join('|')})\Z/i.match?(fname)
             FileUtils.mkdir_p(destdir)
             debug("Copy #{resdir}/#{fname} to the temporary directory.")
             FileUtils.cp(File.join(resdir, fname), destdir, preserve: true)
@@ -315,15 +319,25 @@ module ReVIEW
       File.open(File.join(basetmpdir, htmlfile), 'w') do |f|
         @part_number = part.number
         @part_title = part.name.strip
-        @body = ReVIEW::Template.generate(path: 'html/_part_body.html.erb', binding: binding)
-
+        @body = ReVIEW::Template.generate(path: template_name(localfile: '_part_body.html.erb', systemfile: 'html/_part_body.html.erb'), binding: binding)
         @language = @producer.config['language']
         @stylesheets = @producer.config['stylesheet']
         f.write ReVIEW::Template.generate(path: template_name, binding: binding)
       end
     end
 
-    def template_name
+    def template_name(localfile: 'layout.html.erb', systemfile: nil)
+      if @basedir
+        layoutfile = File.join(@basedir, 'layouts', localfile)
+        if File.exist?(layoutfile)
+          return layoutfile
+        end
+      end
+
+      if systemfile
+        return systemfile
+      end
+
       if @producer.config['htmlversion'].to_i == 5
         './html/layout-html5.html.erb'
       else
@@ -376,7 +390,7 @@ module ReVIEW
 
       if @config['params'].present?
         warn %Q('params:' in config.yml is obsoleted.)
-        if @config['params'] =~ /stylesheet=/
+        if /stylesheet=/.match?(@config['params'])
           warn %Q(stylesheets should be defined in 'stylesheet:', not in 'params:')
         end
       end
@@ -384,7 +398,7 @@ module ReVIEW
         @converter.convert(filename, File.join(basetmpdir, htmlfile))
         write_info_body(basetmpdir, id, htmlfile, ispart, chaptype)
         remove_hidden_title(basetmpdir, htmlfile)
-      rescue => e
+      rescue StandardError => e
         @compile_errors = true
         error "compile error in #{filename} (#{e.class})"
         error e.message
@@ -436,11 +450,11 @@ module ReVIEW
       end
 
       properties = detect_properties(path)
-      if properties.present?
-        prop_str = ',properties=' + properties.join(' ')
-      else
-        prop_str = ''
-      end
+      prop_str = if properties.present?
+                   ',properties=' + properties.join(' ')
+                 else
+                   ''
+                 end
       first = true
       headlines.each do |headline|
         if ispart.present? && headline['level'] == 1
@@ -545,25 +559,12 @@ module ReVIEW
     end
 
     def build_titlepage(basetmpdir, htmlfile)
-      # TODO: should be created via epubcommon
       @title = h(@config.name_of('booktitle'))
       File.open(File.join(basetmpdir, htmlfile), 'w') do |f|
-        @body = ''
-        @body << %Q(<div class="titlepage">\n)
-        @body << %Q(<h1 class="tp-title">#{h(@config.name_of('booktitle'))}</h1>\n)
-        if @config['subtitle']
-          @body << %Q(<h2 class="tp-subtitle">#{h(@config.name_of('subtitle'))}</h2>\n)
-        end
-        if @config['aut']
-          @body << %Q(<h2 class="tp-author">#{h(@config.names_of('aut').join(ReVIEW::I18n.t('names_splitter')))}</h2>\n)
-        end
-        if @config['pbl']
-          @body << %Q(<h3 class="tp-publisher">#{h(@config.names_of('pbl').join(ReVIEW::I18n.t('names_splitter')))}</h3>\n)
-        end
-        @body << '</div>'
-
+        @body = ReVIEW::Template.generate(path: template_name(localfile: '_titlepage.html.erb', systemfile: 'html/_titlepage.html.erb'), binding: binding)
         @language = @producer.config['language']
         @stylesheets = @producer.config['stylesheet']
+
         f.write ReVIEW::Template.generate(path: template_name, binding: binding)
       end
     end

data/lib/review/extentions/string.rb

@@ -1,4 +1,4 @@
-if defined?(Encoding) && Encoding.respond_to?('default_external') &&
+if defined?(Encoding) && Encoding.respond_to?(:default_external) &&
    Encoding.default_external != Encoding::UTF_8
   Encoding.default_external = 'UTF-8'
 end

data/lib/review/htmlbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2021 Minero Aoki, Kenshi Muto, Masayoshi Takahashi,
+# Copyright (c) 2008-2022 Minero Aoki, Kenshi Muto, Masayoshi Takahashi,
 #                         KADO Masanori
 #               2002-2007 Minero Aoki
 #
@@ -67,11 +67,11 @@ module ReVIEW
         htmldir = 'html'
         localfilename = 'layout.html.erb'
       end
-      if @book.htmlversion == 5
-        htmlfilename = File.join(htmldir, 'layout-html5.html.erb')
-      else
-        htmlfilename = File.join(htmldir, 'layout-xhtml1.html.erb')
-      end
+      htmlfilename = if @book.htmlversion == 5
+                       File.join(htmldir, 'layout-html5.html.erb')
+                     else
+                       File.join(htmldir, 'layout-xhtml1.html.erb')
+                     end
 
       layout_file = File.join(@book.basedir, 'layouts', localfilename)
       if !File.exist?(layout_file) && File.exist?(File.join(@book.basedir, 'layouts', 'layout.erb'))
@@ -861,7 +861,7 @@ EOS
       end
       begin
         puts %Q(<img src="#{@chapter.image(id).path.sub(%r{\A\./}, '')}" alt="#{escape(compile_inline(caption))}"#{metrics} />)
-      rescue
+      rescue StandardError
         warn "image not bound: #{id}", location: location
         if lines
           puts %Q(<pre class="dummyimage">)
@@ -977,8 +977,9 @@ EOS
     def compile_kw(word, alt)
       %Q(<b class="kw">) +
         if alt
-        then escape(word + " (#{alt.strip})")
-        else escape(word)
+          escape(word + " (#{alt.strip})")
+        else
+          escape(word)
         end +
         "</b><!-- IDX:#{escape_comment(escape(word))} -->"
     end
@@ -1096,11 +1097,11 @@ EOS
 
     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']
         anchor = 'h' + n.tr('.', '-')
         %Q(<a href="#{chap.id}#{extname}##{anchor}">#{str}</a>)
@@ -1250,7 +1251,7 @@ EOS
     def inline_icon(id)
       begin
         %Q(<img src="#{@chapter.image(id).path.sub(%r{\A\./}, '')}" alt="[#{id}]" />)
-      rescue
+      rescue StandardError
         warn "image not bound: #{id}", location: location
         %Q(<pre>missing image: #{id}</pre>)
       end

data/lib/review/htmlutils.rb

@@ -9,7 +9,7 @@
 
 begin
   require 'cgi/escape'
-rescue
+rescue StandardError
   require 'cgi/util'
 end
 
@@ -60,13 +60,13 @@ module ReVIEW
     def highlight_pygments(ops)
       body = ops[:body] || ''
       format = ops[:format] || ''
-      if ops[:lexer].present?
-        lexer = ops[:lexer]
-      elsif @book.config['highlight'] && @book.config['highlight']['lang']
-        lexer = @book.config['highlight']['lang'] # default setting
-      else
-        lexer = 'text'
-      end
+      lexer = if ops[:lexer].present?
+                ops[:lexer]
+              elsif @book.config['highlight'] && @book.config['highlight']['lang']
+                @book.config['highlight']['lang'] # default setting
+              else
+                'text'
+              end
       options = { nowrap: true, noclasses: true }
       if ops[:linenum]
         options[:nowrap] = false
@@ -93,13 +93,13 @@ module ReVIEW
 
     def highlight_rouge(ops)
       body = ops[:body] || ''
-      if ops[:lexer].present?
-        lexer = ops[:lexer]
-      elsif @book.config['highlight'] && @book.config['highlight']['lang']
-        lexer = @book.config['highlight']['lang'] # default setting
-      else
-        lexer = 'text'
-      end
+      lexer = if ops[:lexer].present?
+                ops[:lexer]
+              elsif @book.config['highlight'] && @book.config['highlight']['lang']
+                @book.config['highlight']['lang'] # default setting
+              else
+                'text'
+              end
       # format = ops[:format] || ''
 
       first_line_num = 1 ## default
@@ -129,9 +129,9 @@ module ReVIEW
     end
 
     def normalize_id(id)
-      if id =~ /\A[a-z][a-z0-9_.-]*\Z/i
+      if /\A[a-z][a-z0-9_.-]*\Z/i.match?(id)
         id
-      elsif id =~ /\A[0-9_.-][a-z0-9_.-]*\Z/i
+      elsif /\A[0-9_.-][a-z0-9_.-]*\Z/i.match?(id)
         "id_#{id}" # dummy prefix
       else
         "id_#{CGI.escape(id.gsub('_', '__')).tr('%', '_').tr('+', '-')}" # escape all

data/lib/review/i18n.rb

@@ -75,11 +75,11 @@ module ReVIEW
     end
 
     def load_file(path)
-      @store = YAML.load_file(path)
+      @store = YAMLLoader.safe_load_file(path)
     end
 
     def update_localefile(path)
-      user_i18n = YAML.load_file(path)
+      user_i18n = YAMLLoader.safe_load_file(path)
       locale = user_i18n['locale']
       if locale
         user_i18n.delete('locale')
@@ -171,7 +171,7 @@ module ReVIEW
       args_matched = (frmt.count('%') <= args.size)
       frmt.gsub!('##', '%%')
       args_matched ? (frmt % args) : frmt
-    rescue
+    rescue StandardError
       str
     end
   end