review 5.1.1 → 5.4.0

data/lib/review/latexbuilder.rb

@@ -28,6 +28,7 @@ module ReVIEW
     end
 
     def builder_init_file
+      super
       @chapter.book.image_types = %w[.ai .eps .pdf .tif .tiff .png .bmp .jpg .jpeg .gif]
       @blank_needed = false
       @latex_tsize = nil
@@ -35,7 +36,6 @@ module ReVIEW
       @cellwidth = nil
       @ol_num = nil
       @first_line_num = nil
-      @sec_counter = SecCounter.new(5, @chapter)
       @foottext = {}
       setup_index
       initialize_metachars(@book.config['texcommand'])
@@ -61,7 +61,7 @@ module ReVIEW
         require 'nkf'
         @index_mecab = MeCab::Tagger.new(@book.config['pdfmaker']['makeindex_mecab_opts'])
       rescue LoadError
-        warn 'not found MeCab'
+        warn 'not found MeCab', location: location
       end
     end
 
@@ -98,6 +98,8 @@ module ReVIEW
     private :puts
 
     def result
+      check_printendnotes
+
       if @chapter.is_a?(ReVIEW::Book::Part) && !@book.config.check_version('2', exception: false)
         puts '\end{reviewpart}'
       end
@@ -155,8 +157,8 @@ module ReVIEW
         puts macro('label', sec_label(anchor))
         puts macro('label', label) if label
       end
-    rescue
-      error "unknown level: #{level}"
+    rescue StandardError
+      app_error "unknown level: #{level}"
     end
 
     def nonum_begin(level, _label, caption)
@@ -197,12 +199,11 @@ module ReVIEW
       blank
       @doc_status[:column] = true
 
-      target = nil
-      if label
-        target = "\\hypertarget{#{column_label(label)}}{}"
-      else
-        target = "\\hypertarget{#{column_label(caption)}}{}"
-      end
+      target = if label
+                 "\\hypertarget{#{column_label(label)}}{}"
+               else
+                 "\\hypertarget{#{column_label(caption)}}{}"
+               end
 
       @doc_status[:caption] = true
       if @book.config.check_version('2', exception: false)
@@ -474,13 +475,13 @@ module ReVIEW
           captionstr = macro(command + 'caption', compile_inline(caption))
         else
           begin
-            if get_chap.nil?
-              captionstr = macro('reviewlistcaption', "#{I18n.t('list')}#{I18n.t('format_number_header_without_chapter', [@chapter.list(id).number])}#{I18n.t('caption_prefix')}#{compile_inline(caption)}")
-            else
-              captionstr = macro('reviewlistcaption', "#{I18n.t('list')}#{I18n.t('format_number_header', [get_chap, @chapter.list(id).number])}#{I18n.t('caption_prefix')}#{compile_inline(caption)}")
-            end
+            captionstr = if get_chap.nil?
+                           macro('reviewlistcaption', "#{I18n.t('list')}#{I18n.t('format_number_header_without_chapter', [@chapter.list(id).number])}#{I18n.t('caption_prefix')}#{compile_inline(caption)}")
+                         else
+                           macro('reviewlistcaption', "#{I18n.t('list')}#{I18n.t('format_number_header', [get_chap, @chapter.list(id).number])}#{I18n.t('caption_prefix')}#{compile_inline(caption)}")
+                         end
           rescue KeyError
-            error "no such list: #{id}"
+            app_error "no such list: #{id}"
           end
         end
       end
@@ -576,13 +577,12 @@ module ReVIEW
     end
 
     def image_image(id, caption = '', metric = nil)
-      captionstr = nil
       @doc_status[:caption] = true
-      if @book.config.check_version('2', exception: false)
-        captionstr = macro('caption', compile_inline(caption)) + "\n"
-      else
-        captionstr = macro('reviewimagecaption', compile_inline(caption)) + "\n"
-      end
+      captionstr = if @book.config.check_version('2', exception: false)
+                     macro('caption', compile_inline(caption)) + "\n"
+                   else
+                     macro('reviewimagecaption', compile_inline(caption)) + "\n"
+                   end
       captionstr << macro('label', image_label(id))
       @doc_status[:caption] = nil
 
@@ -613,19 +613,19 @@ module ReVIEW
     end
 
     def image_dummy(id, caption, lines)
-      warn "image not bound: #{id}"
+      warn "image not bound: #{id}", location: location
       puts '\begin{reviewdummyimage}'
-      # path = @chapter.image(id).path
-      puts "--[[path = #{id} (#{existence(id)})]]--"
+      puts escape("--[[path = #{id} (#{existence(id)})]]--")
       lines.each do |line|
+        puts "\n"
         puts detab(line.rstrip)
       end
       puts macro('label', image_label(id))
       @doc_status[:caption] = true
       if @book.config.check_version('2', exception: false)
         puts macro('caption', compile_inline(caption)) if caption.present?
-      else
-        puts macro('reviewimagecaption', compile_inline(caption)) if caption.present?
+      elsif caption.present?
+        puts macro('reviewimagecaption', compile_inline(caption))
       end
       @doc_status[:caption] = nil
       puts '\end{reviewdummyimage}'
@@ -700,10 +700,11 @@ module ReVIEW
           puts "\\#{command}[width=\\maxwidth]{#{@chapter.image(id).path}}"
         end
       else
-        warn "image not bound: #{id}"
+        warn "image not bound: #{id}", location: location
         puts '\begin{reviewdummyimage}'
-        puts "--[[path = #{escape(id)} (#{existence(id)})]]--"
+        puts escape("--[[path = #{escape(id)} (#{existence(id)})]]--")
         lines.each do |line|
+          puts "\n"
           puts detab(line.rstrip)
         end
       end
@@ -736,7 +737,7 @@ module ReVIEW
           table_header(id, caption)
         end
       rescue KeyError
-        error "no such table: #{id}"
+        app_error "no such table: #{id}"
       end
       table_begin(rows.first.size)
       table_rows(sepidx, rows)
@@ -802,7 +803,7 @@ module ReVIEW
       end
 
       if @tsize
-        if @tsize =~ /\A[\d., ]+\Z/
+        if /\A[\d., ]+\Z/.match?(@tsize)
           @cellwidth = @tsize.split(/\s*,\s*/)
           @cellwidth.collect! { |i| "p{#{i}mm}" }
           puts macro('begin', 'reviewtable', '|' + @cellwidth.join('|') + '|')
@@ -821,7 +822,7 @@ module ReVIEW
       ret = []
       s = ''
       brace = nil
-      size.split('').each do |ch|
+      size.chars.each do |ch|
         case ch
         when '|'
           next
@@ -834,15 +835,11 @@ module ReVIEW
           ret << s
           s = ''
         else
-          if brace
+          if brace || s.empty?
             s << ch
           else
-            if s.empty?
-              s << ch
-            else
-              ret << s
-              s = ch
-            end
+            ret << s
+            s = ch
           end
         end
       end
@@ -859,7 +856,7 @@ module ReVIEW
     end
 
     def th(s, cellwidth = 'l')
-      if /\\\\/ =~ s
+      if /\\\\/.match?(s)
         if !@book.config.check_version('2', exception: false) && cellwidth =~ /\{/
           macro('reviewth', s.gsub("\\\\\n", '\\newline{}'))
         else
@@ -872,7 +869,7 @@ module ReVIEW
     end
 
     def td(s, cellwidth = 'l')
-      if /\\\\/ =~ s
+      if /\\\\/.match?(s)
         if !@book.config.check_version('2', exception: false) && cellwidth =~ /\{/
           s.gsub("\\\\\n", '\\newline{}')
         else
@@ -902,7 +899,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
@@ -920,7 +917,7 @@ module ReVIEW
         end
         puts macro('label', table_label(id))
       rescue ReVIEW::KeyError
-        error "no such table: #{id}"
+        app_error "no such table: #{id}"
       end
       imgtable_image(id, caption, metric)
 
@@ -971,11 +968,11 @@ module ReVIEW
 
       if id
         puts macro('begin', 'reviewequationblock')
-        if get_chap.nil?
-          captionstr = macro('reviewequationcaption', "#{I18n.t('equation')}#{I18n.t('format_number_header_without_chapter', [@chapter.equation(id).number])}#{I18n.t('caption_prefix')}#{compile_inline(caption)}")
-        else
-          captionstr = macro('reviewequationcaption', "#{I18n.t('equation')}#{I18n.t('format_number_header', [get_chap, @chapter.equation(id).number])}#{I18n.t('caption_prefix')}#{compile_inline(caption)}")
-        end
+        captionstr = if get_chap.nil?
+                       macro('reviewequationcaption', "#{I18n.t('equation')}#{I18n.t('format_number_header_without_chapter', [@chapter.equation(id).number])}#{I18n.t('caption_prefix')}#{compile_inline(caption)}")
+                     else
+                       macro('reviewequationcaption', "#{I18n.t('equation')}#{I18n.t('format_number_header', [get_chap, @chapter.equation(id).number])}#{I18n.t('caption_prefix')}#{compile_inline(caption)}")
+                     end
       end
 
       if caption_top?('equation') && captionstr
@@ -1056,7 +1053,7 @@ module ReVIEW
         title
       end
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
       nofunc_text("[UnknownChapter:#{id}]")
     end
 
@@ -1067,7 +1064,7 @@ module ReVIEW
         @book.chapter_index.number(id)
       end
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
       nofunc_text("[UnknownChapter:#{id}]")
     end
 
@@ -1079,7 +1076,7 @@ module ReVIEW
         title
       end
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
       nofunc_text("[UnknownChapter:#{id}]")
     end
 
@@ -1096,7 +1093,7 @@ module ReVIEW
         macro('reviewlistref', I18n.t('format_number', [get_chap(chapter), chapter.list(id).number]))
       end
     rescue KeyError
-      error "unknown list: #{id}"
+      app_error "unknown list: #{id}"
     end
 
     def inline_table(id)
@@ -1107,7 +1104,7 @@ module ReVIEW
         macro('reviewtableref', I18n.t('format_number', [get_chap(chapter), chapter.table(id).number]), table_label(id, chapter))
       end
     rescue KeyError
-      error "unknown table: #{id}"
+      app_error "unknown table: #{id}"
     end
 
     def inline_img(id)
@@ -1118,7 +1115,7 @@ module ReVIEW
         macro('reviewimageref', I18n.t('format_number', [get_chap(chapter), chapter.image(id).number]), image_label(id, chapter))
       end
     rescue KeyError
-      error "unknown image: #{id}"
+      app_error "unknown image: #{id}"
     end
 
     def inline_eq(id)
@@ -1129,13 +1126,13 @@ module ReVIEW
         macro('reviewequationref', I18n.t('format_number', [get_chap(chapter), chapter.equation(id).number]))
       end
     rescue KeyError
-      error "unknown equation: #{id}"
+      app_error "unknown equation: #{id}"
     end
 
     def footnote(id, content)
       if @book.config['footnotetext'] || @foottext[id]
         if @doc_status[:column]
-          warn "//footnote[#{id}] is in the column block. It is recommended to move out of the column block."
+          warn "//footnote[#{id}] is in the column block. It is recommended to move out of the column block.", location: location
         end
         puts macro("footnotetext[#{@chapter.footnote(id).number}]", compile_inline(content.strip))
       end
@@ -1151,7 +1148,20 @@ module ReVIEW
         macro('footnote', compile_inline(@chapter.footnote(id).content.strip))
       end
     rescue KeyError
-      error "unknown footnote: #{id}"
+      app_error "unknown footnote: #{id}"
+    end
+
+    def inline_endnote(id)
+      macro('endnote', compile_inline(@chapter.endnote(id).content.strip))
+    rescue KeyError
+      app_error "unknown footnote: #{id}"
+    end
+
+    def printendnotes
+      @shown_endnotes = true
+      blank
+      puts '\theendnotes'
+      blank
     end
 
     BOUTEN = '・'.freeze
@@ -1267,11 +1277,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', [chap.headline_index.number(id), 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', [chap.headline_index.number(id), 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 = n.tr('.', '-')
         macro('reviewsecref', str, sec_label(anchor))
@@ -1285,7 +1295,7 @@ module ReVIEW
             I18n.t('column', compile_inline(chapter.column(id).caption)),
             column_label(id, chapter))
     rescue KeyError
-      error "unknown column: #{id}"
+      app_error "unknown column: #{id}"
     end
 
     def inline_raw(str) # rubocop:disable Lint/UselessMethodDefinition
@@ -1324,7 +1334,7 @@ module ReVIEW
         end
         macro(command, @chapter.image(id).path)
       else
-        warn "image not bound: #{id}"
+        warn "image not bound: #{id}", location: location
         "\\verb|--[[path = #{id} (#{existence(id)})]]--|"
       end
     end
@@ -1348,7 +1358,7 @@ module ReVIEW
     end
 
     def inline_tcy(str)
-      macro('rensuji', escape(str))
+      macro('reviewtcy', escape(str))
     end
 
     def inline_balloon(str)
@@ -1377,18 +1387,16 @@ module ReVIEW
       sa.map! do |item|
         if @index_db[item]
           escape_mendex_key(escape_index(@index_db[item])) + '@' + escape_mendex_display(escape_index(escape(item)))
-        else
-          if item =~ /\A[[:ascii:]]+\Z/ || @index_mecab.nil?
-            esc_item = escape_mendex_display(escape_index(escape(item)))
-            if esc_item == item
-              esc_item
-            else
-              "#{escape_mendex_key(escape_index(item))}@#{esc_item}"
-            end
+        elsif item =~ /\A[[:ascii:]]+\Z/ || @index_mecab.nil?
+          esc_item = escape_mendex_display(escape_index(escape(item)))
+          if esc_item == item
+            esc_item
           else
-            yomi = NKF.nkf('-w --hiragana', @index_mecab.parse(item).force_encoding('UTF-8').chomp)
-            escape_mendex_key(escape_index(yomi)) + '@' + escape_mendex_display(escape_index(escape(item)))
+            "#{escape_mendex_key(escape_index(item))}@#{esc_item}"
           end
+        else
+          yomi = NKF.nkf('-w --hiragana', @index_mecab.parse(item).force_encoding('UTF-8').chomp)
+          escape_mendex_key(escape_index(yomi)) + '@' + escape_mendex_display(escape_index(escape(item)))
         end
       end
 
@@ -1404,7 +1412,7 @@ module ReVIEW
     end
 
     def compile_href(url, label)
-      if /\A[a-z]+:/ =~ url
+      if /\A[a-z]+:/.match?(url)
         if label
           macro('href', escape_url(url), escape(label))
         else

data/lib/review/lineinput.rb

@@ -31,7 +31,7 @@ module ReVIEW
     def skip_comment_lines
       n = 0
       while line = gets
-        unless line.strip =~ /\A\#@/
+        unless /\A\#@/.match?(line.strip)
           ungets(line)
           return n
         end
@@ -88,7 +88,7 @@ module ReVIEW
 
     def while_match(re)
       while line = gets
-        unless re =~ line
+        unless re&.match?(line)
           ungets(line)
           return
         end
@@ -99,7 +99,7 @@ module ReVIEW
 
     def until_match(re)
       while line = gets
-        if re =~ line
+        if re&.match?(line)
           ungets(line)
           return
         end

data/lib/review/location.rb

@@ -22,7 +22,7 @@ module ReVIEW
     def string
       begin
         "#{@filename}:#{@f.lineno}"
-      rescue
+      rescue StandardError
         "#{@filename}:nil"
       end
     end

data/lib/review/loggable.rb

@@ -0,0 +1,27 @@
+module ReVIEW
+  module Loggable
+    attr_reader :logger
+
+    def error(msg, location: nil)
+      logger.error(msg, location: location)
+    end
+
+    def app_error(msg)
+      raise ApplicationError, msg
+    end
+
+    def error!(msg, location: nil)
+      logger.error(msg, location: location)
+
+      exit 1
+    end
+
+    def warn(msg, location: nil)
+      logger.warn(msg, location: location)
+    end
+
+    def debug(msg, location: nil)
+      logger.debug(msg, location: location)
+    end
+  end
+end

data/lib/review/logger.rb

@@ -7,6 +7,30 @@ module ReVIEW
       self.formatter = ->(severity, _datetime, name, msg) { "#{severity} #{name}: #{msg}\n" }
     end
 
+    def warn(msg, location: nil)
+      if location
+        super("#{location}: #{msg}")
+      else
+        super(msg)
+      end
+    end
+
+    def error(msg, location: nil)
+      if location
+        super("#{location}: #{msg}")
+      else
+        super(msg)
+      end
+    end
+
+    def debug(msg, location: nil)
+      if location
+        super("#{location}: #{msg}")
+      else
+        super(msg)
+      end
+    end
+
     def ttylogger?
       nil
     end
@@ -19,6 +43,30 @@ module ReVIEW
   begin
     require 'tty-logger'
     class TTYLogger < ::TTY::Logger
+      def warn(msg, location: nil)
+        if location
+          super("#{location}: #{msg}")
+        else
+          super(msg)
+        end
+      end
+
+      def error(msg, location: nil)
+        if location
+          super("#{location}: #{msg}")
+        else
+          super(msg)
+        end
+      end
+
+      def debug(msg, location: nil)
+        if location
+          super("#{location}: #{msg}")
+        else
+          super(msg)
+        end
+      end
+
       def ttylogger?
         true
       end
@@ -28,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}"
@@ -61,7 +61,11 @@ module ReVIEW
             exts = options[:exts] || %w[png gif jpg jpeg svg pdf eps ai tif psd]
             exts_str = exts.join('|')
             if !is_converted && fname =~ /\.(#{exts_str})$/i
-              FileUtils.cp("#{from_dir}/#{fname}", to_dir)
+              if options[:use_symlink]
+                FileUtils.ln_s(File.realpath("#{from_dir}/#{fname}"), to_dir)
+              else
+                FileUtils.cp("#{from_dir}/#{fname}", to_dir)
+              end
               image_files << "#{from_dir}/#{fname}"
             end
           end