review 5.2.0 → 5.5.0

data/lib/review/logger.rb

@@ -76,27 +76,27 @@ module ReVIEW
   end
 
   def self.logger(level: 'info')
-    if const_defined?(:TTYLogger)
-      @logger ||= TTYLogger.new do |config|
-        config.level = level.to_sym
-        config.handlers = [
-          [:console,
-           {
-             styles: {
-               debug: { label: 'DEBUG' },
-               info: { label: 'INFO', color: :magenta },
-               success: { label: 'SUCCESS' },
-               wait: { label: 'WAIT' },
-               warn: { label: 'WARN' },
-               error: { label: 'ERROR' },
-               fatal: { label: 'FATAL' }
-             }
-           }]
-        ]
-      end
-    else
-      @logger ||= ReVIEW::Logger.new($stderr, progname: File.basename($PROGRAM_NAME, '.*'))
-    end
+    @logger ||= if const_defined?(:TTYLogger)
+                  TTYLogger.new do |config|
+                    config.level = level.to_sym
+                    config.handlers = [
+                      [:console,
+                       {
+                         styles: {
+                           debug: { label: 'DEBUG' },
+                           info: { label: 'INFO', color: :magenta },
+                           success: { label: 'SUCCESS' },
+                           wait: { label: 'WAIT' },
+                           warn: { label: 'WARN' },
+                           error: { label: 'ERROR' },
+                           fatal: { label: 'FATAL' }
+                         }
+                       }]
+                    ]
+                  end
+                else
+                  ReVIEW::Logger.new($stderr, progname: File.basename($PROGRAM_NAME, '.*'))
+                end
   end
 
   def self.logger=(logger)

data/lib/review/makerhelper.rb

@@ -11,7 +11,7 @@ require 'yaml'
 
 begin
   require 'cgi/escape'
-rescue
+rescue StandardError
   require 'cgi/util'
 end
 
@@ -43,7 +43,7 @@ module ReVIEW
 
       Dir.open(from_dir) do |dir|
         dir.each do |fname|
-          next if fname =~ /^\./
+          next if /^\./.match?(fname)
 
           if FileTest.directory?("#{from_dir}/#{fname}")
             image_files += copy_images_to_dir("#{from_dir}/#{fname}", "#{to_dir}/#{fname}", options)
@@ -52,7 +52,7 @@ module ReVIEW
 
             is_converted = false
             (options[:convert] || {}).each do |orig_type, conv_type|
-              next unless /\.#{orig_type}$/ =~ fname
+              next unless /\.#{orig_type}$/.match?(fname)
 
               is_converted = system("convert #{from_dir}/#{fname} #{to_dir}/#{fname}.#{conv_type}")
               image_files << "#{from_dir}/#{fname}.#{conv_type}"

data/lib/review/markdownbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2020 KADO Masanori, Masayoshi Takahashi, Kenshi Muto
+# Copyright (c) 2013-2021 KADO Masanori, Masayoshi Takahashi, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -98,7 +98,7 @@ module ReVIEW
     end
 
     def ul_item_begin(lines)
-      puts '  ' * (@ul_indent - 1) + '* ' + join_lines_to_paragraph(lines)
+      puts ('  ' * (@ul_indent - 1)) + '* ' + join_lines_to_paragraph(lines)
     end
 
     def ul_item_end
@@ -255,11 +255,11 @@ module ReVIEW
 
     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']
         if @chapter == chap
           anchor = 'h' + n.tr('.', '-')
@@ -361,6 +361,14 @@ module ReVIEW
       "[^#{id}]"
     end
 
+    def inline_endnote(id)
+      "<sup>#{I18n.t('html_endnote_refmark', @chapter.endnote(id).number)}</sup>"
+    end
+
+    def endnote_item(id)
+      puts "#{I18n.t('html_endnote_textmark', @chapter.endnote(id).number)}#{compile_inline(@chapter.endnote(id).content)}"
+    end
+
     def inline_br(_str)
       "\n"
     end
@@ -401,7 +409,7 @@ module ReVIEW
     def inline_icon(id)
       begin
         "![](#{@chapter.image(id).path.sub(%r{\A\./}, '')})"
-      rescue
+      rescue StandardError
         warn "image not bound: #{id}", location: location
         %Q(<pre>missing image: #{id}</pre>)
       end

data/lib/review/pdfmaker.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
@@ -121,9 +121,13 @@ module ReVIEW
       cmd_config, yamlfile = parse_opts(args)
       error! "#{yamlfile} not found." unless File.exist?(yamlfile)
 
-      @config = ReVIEW::Configure.create(maker: 'pdfmaker',
-                                         yamlfile: yamlfile,
-                                         config: cmd_config)
+      begin
+        @config = ReVIEW::Configure.create(maker: 'pdfmaker',
+                                           yamlfile: yamlfile,
+                                           config: cmd_config)
+      rescue ReVIEW::ConfigError => e
+        error! e.message
+      end
 
       I18n.setup(@config['language'])
       @basedir = File.absolute_path(File.dirname(yamlfile))
@@ -136,11 +140,11 @@ module ReVIEW
 
       # version 2 compatibility
       unless @config['texdocumentclass']
-        if @config.check_version(2, exception: false)
-          @config['texdocumentclass'] = ['jsbook', 'uplatex,oneside']
-        else
-          @config['texdocumentclass'] = @config['_texdocumentclass']
-        end
+        @config['texdocumentclass'] = if @config.check_version(2, exception: false)
+                                        ['jsbook', 'uplatex,oneside']
+                                      else
+                                        @config['_texdocumentclass']
+                                      end
       end
 
       begin
@@ -193,7 +197,7 @@ module ReVIEW
     def build_pdf
       template = template_content
       Dir.chdir(@path) do
-        File.open("./#{@mastertex}.tex", 'wb') { |f| f.write template }
+        File.write("./#{@mastertex}.tex", template)
 
         call_hook('hook_beforetexcompile', Dir.pwd, @basedir, base_dir: @basedir)
 
@@ -297,7 +301,7 @@ module ReVIEW
       @logger.info "compiling #{filename}.tex"
       begin
         @converter.convert(filename + '.re', File.join(@path, filename + '.tex'))
-      rescue => e
+      rescue StandardError => e
         @compile_errors = true
         error "compile error in #{filename}.tex (#{e.class})"
         error e.message
@@ -318,12 +322,16 @@ module ReVIEW
     end
 
     def make_custom_page(file)
+      if file.nil?
+        return nil
+      end
+
       file_sty = file.to_s.sub(/\.[^.]+\Z/, '.tex')
       if File.exist?(file_sty)
-        return File.read(file_sty)
+        File.read(file_sty)
+      else
+        warn "File #{file_sty} is not found."
       end
-
-      nil
     end
 
     def join_with_separator(value, sep)
@@ -373,9 +381,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)
               buf << 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　](.+)/) { |m| buf << ReVIEW::I18n.t('published_by3', [date_to_s(m[1]), m[2]]) }
             else
@@ -442,6 +450,10 @@ module ReVIEW
           end
       end
 
+      if @config['coverimage'] && !File.exist?(File.join(@config['imagedir'], @config['coverimage']))
+        raise ReVIEW::ConfigError, "coverimage #{@config['coverimage']} is not found."
+      end
+
       @locale_latex = {}
       part_tuple = I18n.get('part').split(/%[A-Za-z]{1,3}/, 2)
       chapter_tuple = I18n.get('chapter').split(/%[A-Za-z]{1,3}/, 2)
@@ -475,17 +487,24 @@ module ReVIEW
 
     def template_content
       template_dir = ReVIEW::Template::TEMPLATE_DIR
-      if @config.check_version('2', exception: false)
-        template_path = './latex-compat2/layout.tex.erb'
-      else
-        template_path = './latex/layout.tex.erb'
-      end
+      template_path = if @config.check_version('2', exception: false)
+                        './latex-compat2/layout.tex.erb'
+                      else
+                        './latex/layout.tex.erb'
+                      end
       layout_file = File.join(@basedir, 'layouts', 'layout.tex.erb')
       if File.exist?(layout_file)
         template_dir = @basedir
         template_path = 'layouts/layout.tex.erb'
       end
       ReVIEW::Template.generate(path: template_path, mode: '-', binding: binding, template_dir: template_dir)
+    rescue StandardError => e
+      if defined?(e.full_message)
+        error! "template or configuration error: #{e.full_message(highlight: false)}"
+      else
+        # <= Ruby 2.4
+        error! "template or configuration error: #{e.message}"
+      end
     end
 
     def copy_sty(dirname, copybase, extname = 'sty')

data/lib/review/plaintextbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2018-2020 Kenshi Muto
+# Copyright (c) 2018-2022 Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -74,6 +74,7 @@ module ReVIEW
     private :blank
 
     def result
+      check_printendnotes
       solve_nest(@output.string)
     end
 
@@ -85,11 +86,11 @@ module ReVIEW
         if l =~ /\A\x01→(dl|ul|ol)←\x01/
           clevel.push($1)
           lines.push("\x01→END←\x01")
-        elsif l =~ %r{\A\x01→/(dl|ul|ol)←\x01}
+        elsif %r{\A\x01→/(dl|ul|ol)←\x01}.match?(l)
           clevel.pop
           lines.push("\x01→END←\x01")
         else
-          lines.push("\t" * clevel.size + l)
+          lines.push(("\t" * clevel.size) + l)
         end
       end
 
@@ -213,14 +214,14 @@ module ReVIEW
 
     def emlistnum(lines, caption = nil, _lang = nil)
       blank
-      if caption_top?('list')
-        puts compile_inline(caption) if caption.present?
+      if caption_top?('list') && caption.present?
+        puts compile_inline(caption)
       end
       lines.each_with_index do |line, i|
         puts((i + 1).to_s.rjust(2) + ": #{line}")
       end
-      unless caption_top?('list')
-        puts compile_inline(caption) if caption.present?
+      if !caption_top?('list') && caption.present?
+        puts compile_inline(caption)
       end
       blank
     end

data/lib/review/preprocessor/repository.rb

@@ -165,7 +165,7 @@ module ReVIEW
       end
 
       def check_spec(spec)
-        app_error "wrong spec: #{spec.inspect}" unless /\A\w+\z/ =~ spec
+        app_error "wrong spec: #{spec.inspect}" unless /\A\w+\z/.match?(spec)
         spec
       end
 

data/lib/review/preprocessor.rb

@@ -70,11 +70,11 @@ module ReVIEW
             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
+            ent = if direc['eval']
+                    evaluate(path, ent)
+                  else
+                    @repository.fetch_file(path)
+                  end
             replace_block(f, line, ent, false) # FIXME: turn off lineno: tmp
 
           when /\A\#@map(?:range)?/

data/lib/review/rstbuilder.rb

@@ -86,6 +86,7 @@ module ReVIEW
     private :blank
 
     def result
+      check_printendnotes
       solve_nest(@output.string)
     end
 
@@ -124,7 +125,7 @@ module ReVIEW
     end
 
     def ul_item(lines)
-      puts '  ' * (@ul_indent - 1) + "* #{join_lines_to_paragraph(lines)}"
+      puts ('  ' * (@ul_indent - 1)) + "* #{join_lines_to_paragraph(lines)}"
     end
 
     def ul_end
@@ -138,7 +139,7 @@ module ReVIEW
     end
 
     def ol_item(lines, _num)
-      puts '  ' * (@ol_indent - 1) + "#. #{join_lines_to_paragraph(lines)}"
+      puts ('  ' * (@ol_indent - 1)) + "#. #{join_lines_to_paragraph(lines)}"
     end
 
     def ol_end
@@ -367,6 +368,14 @@ module ReVIEW
       " [##{id.sub(' ', '_')}]_ "
     end
 
+    def inline_endnote(id)
+      " [(#{@chapter.endnote(id).number})]_ "
+    end
+
+    def endnote_item(id)
+      puts ".. [(#{@chapter.endnote(id).number})] #{compile_inline(@chapter.endnote(id).content)}"
+    end
+
     def compile_ruby(base, ruby)
       " :ruby:`#{base}`<#{ruby}>`_ "
     end

data/lib/review/textmaker.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2018-2021 Kenshi Muto
+# Copyright (c) 2018-2022 Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -74,9 +74,14 @@ module ReVIEW
       cmd_config, yamlfile = parse_opts(args)
       error! "#{yamlfile} not found." unless File.exist?(yamlfile)
 
-      @config = ReVIEW::Configure.create(maker: 'textmaker',
-                                         yamlfile: yamlfile,
-                                         config: cmd_config)
+      begin
+        @config = ReVIEW::Configure.create(maker: 'textmaker',
+                                           yamlfile: yamlfile,
+                                           config: cmd_config)
+      rescue ReVIEW::ConfigError => e
+        error! e.message
+      end
+
       @img_math = ReVIEW::ImgMath.new(@config, path_name: '_review_math_text')
 
       I18n.setup(@config['language'])
@@ -111,12 +116,11 @@ module ReVIEW
 
     def build_body(basetmpdir, _yamlfile)
       base_path = Pathname.new(@basedir)
-      builder = nil
-      if @plaintext
-        builder = ReVIEW::PLAINTEXTBuilder.new(img_math: @img_math)
-      else
-        builder = ReVIEW::TOPBuilder.new(img_math: @img_math)
-      end
+      builder = if @plaintext
+                  ReVIEW::PLAINTEXTBuilder.new(img_math: @img_math)
+                else
+                  ReVIEW::TOPBuilder.new(img_math: @img_math)
+                end
       @converter = ReVIEW::Converter.new(@book, builder)
       @book.parts.each do |part|
         if part.name.present?
@@ -142,13 +146,11 @@ module ReVIEW
     end
 
     def build_chap(chap, base_path, basetmpdir, ispart)
-      filename = ''
-
-      if ispart.present?
-        filename = chap.path
-      else
-        filename = Pathname.new(chap.path).relative_path_from(base_path).to_s
-      end
+      filename = if ispart.present?
+                   chap.path
+                 else
+                   Pathname.new(chap.path).relative_path_from(base_path).to_s
+                 end
       id = File.basename(filename).sub(/\.re\Z/, '')
       if @buildonly && !@buildonly.include?(id)
         warn "skip #{id}.re"
@@ -159,7 +161,7 @@ module ReVIEW
 
       begin
         @converter.convert(filename, File.join(basetmpdir, textfile))
-      rescue => e
+      rescue StandardError => e
         @compile_errors = true
         error "compile error in #{filename} (#{e.class})"
         error e.message

data/lib/review/textutils.rb

@@ -15,7 +15,7 @@ module ReVIEW
       add = 0
       len = nil
       str.gsub("\t") do
-        len = ts - ($`.size + add) % ts
+        len = ts - (($`.size + add) % ts)
         add += len - 1
         ' ' * len
       end
@@ -72,11 +72,10 @@ module ReVIEW
         end
 
         # lazy than rule 3, but it looks better
-        if lazy &&
-           (%i[F W H].include?(Unicode::Eaw.property(tail)) &&
-            tail !~ /\p{Hangul}/) ||
-           (%i[F W H].include?(Unicode::Eaw.property(head)) &&
-            head !~ /\p{Hangul}/)
+        if lazy && ((%i[F W H].include?(Unicode::Eaw.property(tail)) &&
+              tail !~ /\p{Hangul}/) ||
+             (%i[F W H].include?(Unicode::Eaw.property(head)) &&
+              head !~ /\p{Hangul}/))
           space = nil
         end
       end

data/lib/review/tocprinter.rb

@@ -69,12 +69,17 @@ module ReVIEW
 
     def execute(*args)
       parse_options(args)
-      @config = ReVIEW::Configure.create(yamlfile: @yamlfile)
-      @book = ReVIEW::Book::Base.new('.', config: @config)
-      unless File.readable?(@yamlfile)
-        @logger.error("No such fiile or can't open #{@yamlfile}.")
+      begin
+        @config = ReVIEW::Configure.create(yamlfile: @yamlfile)
+        @book = ReVIEW::Book::Base.new('.', config: @config)
+        unless File.readable?(@yamlfile)
+          raise ReVIEW::FileNotFound, "No such fiile or can't open #{@yamlfile}."
+        end
+      rescue ReVIEW::ConfigError, ReVIEW::FileNotFound, ReVIEW::CompileError, ReVIEW::ApplicationError => e
+        @logger.error e.message
         exit 1
       end
+
       I18n.setup(@config['language'])
 
       if @detail
@@ -226,9 +231,9 @@ module ReVIEW
 
       case mode
       when :list
-        (calc_linesize(line) - 1) / @book.page_metric.list.n_columns + 1
+        ((calc_linesize(line) - 1) / @book.page_metric.list.n_columns) + 1
       else # mode == :text
-        (calc_linesize(line) - 1) / @book.page_metric.text.n_columns + 1
+        ((calc_linesize(line) - 1) / @book.page_metric.text.n_columns) + 1
       end
     end
 

data/lib/review/topbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto
+# Copyright (c) 2008-2022 Minero Aoki, Kenshi Muto
 #               2002-2006 Minero Aoki
 #
 # This program is free software.
@@ -262,13 +262,61 @@ module ReVIEW
       blank
     end
 
+    def table_rows(sepidx, rows)
+      if sepidx
+        sepidx.times do
+          tr(rows.shift.map { |s| th(s) })
+        end
+        if !@book.config['textmaker'] || !@book.config['textmaker']['th_bold']
+          puts '-' * 12
+        end
+        rows.each do |cols|
+          tr(cols.map { |s| td(s) })
+        end
+      else
+        rows.each do |cols|
+          h, *cs = *cols
+          tr([th(h)] + cs.map { |s| td(s) })
+        end
+      end
+    end
+
     def th(str)
-      "★#{str}☆"
+      if @book.config['textmaker'] && @book.config['textmaker']['th_bold']
+        "★#{str}☆"
+      else
+        str
+      end
     end
 
     def table_end
     end
 
+    def imgtable(lines, id, caption = nil, metric = nil)
+      metrics = parse_metric('top', metric)
+      metrics = " #{metrics}" if metrics.present?
+      blank
+      puts "◆→開始:#{@titles['table']}←◆"
+      if caption_top?('table') && caption.present?
+        table_header(id, caption)
+      end
+
+      if @chapter.image_bound?(id)
+        puts "◆→#{@chapter.image(id).path}#{metrics}←◆"
+      else
+        warn "image not bound: #{id}", location: location
+        lines.each do |line|
+          puts line
+        end
+      end
+
+      if !caption_top?('table') && caption.present?
+        table_header(id, caption)
+      end
+      puts "◆→終了:#{@titles['table']}←◆"
+      blank
+    end
+
     def comment(lines, comment = nil)
       return unless @book.config['draft']
 
@@ -290,14 +338,33 @@ module ReVIEW
       app_error "unknown footnote: #{id}"
     end
 
+    def inline_endnote(id)
+      "【後注#{@chapter.endnote(id).number}】"
+    rescue KeyError
+      app_error "unknown endnote: #{id}"
+    end
+
+    def endnote_begin
+      puts '◆→開始:後注←◆'
+    end
+
+    def endnote_end
+      puts '◆→終了:後注←◆'
+    end
+
+    def endnote_item(id)
+      puts "【後注#{@chapter.endnote(id).number}】#{compile_inline(@chapter.endnote(id).content)}"
+    end
+
     def compile_ruby(base, ruby)
       "#{base}◆→DTP連絡:「#{base}」に「#{ruby}」とルビ←◆"
     end
 
     def compile_kw(word, alt)
       if alt
-      then "★#{word}☆（#{alt.strip}）"
-      else "★#{word}☆"
+        "★#{word}☆（#{alt.strip}）"
+      else
+        "★#{word}☆"
       end
     end
 
@@ -380,7 +447,7 @@ module ReVIEW
     def inline_icon(id)
       begin
         "◆→画像 #{@chapter.image(id).path.sub(%r{\A\./}, '')}←◆"
-      rescue
+      rescue StandardError
         warn "image not bound: #{id}", location: location
         "◆→画像 #{id}←◆"
       end
@@ -477,27 +544,37 @@ module ReVIEW
       ), __FILE__, __LINE__ - 11
     end
 
-    def indepimage(_lines, id, caption = nil, metric = nil)
+    def indepimage(lines, id, caption = nil, metric = nil)
       metrics = parse_metric('top', metric)
       metrics = " #{metrics}" if metrics.present?
       blank
+      puts "◆→開始:#{@titles['image']}←◆"
       if caption_top?('image') && caption.present?
-        puts "図　#{compile_inline(caption)}"
+        indepimage_header(id, caption)
+        blank
       end
-      begin
-        puts "◆→画像 #{@chapter.image(id).path.sub(%r{\A\./}, '')}#{metrics}←◆"
-      rescue
+      if @chapter.image_bound?(id)
+        puts "◆→#{@chapter.image(id).path}#{metrics}←◆"
+      else
         warn "image not bound: #{id}", location: location
-        puts "◆→画像 #{id}←◆"
+        lines.each do |line|
+          puts line
+        end
       end
       if !caption_top?('image') && caption.present?
-        puts "図　#{compile_inline(caption)}"
+        blank
+        indepimage_header(id, caption)
       end
+      puts "◆→終了:#{@titles['image']}←◆"
       blank
     end
 
     alias_method :numberlessimage, :indepimage
 
+    def indepimage_header(_id, caption)
+      puts "図#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}"
+    end
+
     def inline_code(str)
       "△#{str}☆"
     end