review 5.1.1 → 5.4.0

data/lib/review/rstbuilder.rb

@@ -54,12 +54,12 @@ module ReVIEW
     end
 
     def builder_init_file
+      super
       @section = 0
       @subsection = 0
       @subsubsection = 0
       @subsubsubsection = 0
       @blank_seen = true
-      @sec_counter = SecCounter.new(5, @chapter)
       @ul_indent = 0
       @ol_indent = 0
       @in_role = false
@@ -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/template.rb

@@ -19,7 +19,11 @@ module ReVIEW
       return unless filename
 
       content = File.read(filename)
-      @erb = ERB.new(content, nil, mode)
+      @erb = if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.6')
+               ERB.new(content, trim_mode: mode)
+             else
+               ERB.new(content, nil, mode)
+             end
     end
 
     def result(bind_data = nil)

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
@@ -17,10 +17,12 @@ require 'review/topbuilder'
 require 'review/version'
 require 'review/makerhelper'
 require 'review/img_math'
+require 'review/loggable'
 
 module ReVIEW
   class TEXTMaker
     include MakerHelper
+    include Loggable
 
     attr_accessor :config, :basedir
 
@@ -29,15 +31,7 @@ module ReVIEW
       @logger = ReVIEW.logger
       @plaintext = nil
       @img_math = nil
-    end
-
-    def error(msg)
-      @logger.error msg
-      exit 1
-    end
-
-    def warn(msg)
-      @logger.warn msg
+      @compile_errors = nil
     end
 
     def self.execute(*args)
@@ -78,11 +72,16 @@ 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)
+
+      begin
+        @config = ReVIEW::Configure.create(maker: 'textmaker',
+                                           yamlfile: yamlfile,
+                                           config: cmd_config)
+      rescue ReVIEW::ConfigError => e
+        error! e.message
+      end
 
-      @config = ReVIEW::Configure.create(maker: 'textmaker',
-                                         yamlfile: yamlfile,
-                                         config: cmd_config)
       @img_math = ReVIEW::ImgMath.new(@config, path_name: '_review_math_text')
 
       I18n.setup(@config['language'])
@@ -92,7 +91,7 @@ module ReVIEW
       rescue ApplicationError => e
         raise if @config['debug']
 
-        error(e.message)
+        error! e.message
       end
 
       if @config['math_format'] == 'imgmath'
@@ -109,16 +108,19 @@ module ReVIEW
       @book = ReVIEW::Book::Base.new(@basedir, config: @config)
 
       build_body(@path, yamlfile)
+
+      if @compile_errors
+        app_error 'compile error, No TEXT file output.'
+      end
     end
 
     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?
@@ -144,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"
@@ -161,9 +161,10 @@ module ReVIEW
 
       begin
         @converter.convert(filename, File.join(basetmpdir, textfile))
-      rescue => e
-        warn "compile error in #{filename} (#{e.class})"
-        warn e.message
+      rescue StandardError => e
+        @compile_errors = true
+        error "compile error in #{filename} (#{e.class})"
+        error e.message
       end
     end
   end

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
 
@@ -257,7 +262,7 @@ module ReVIEW
         compiler.compile(@book.chapter(chap.name))
       rescue ReVIEW::ApplicationError => e
         @logger.error e.message
-        exit 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.
@@ -105,7 +105,7 @@ module ReVIEW
           list_header(id, caption, lang)
         end
       rescue KeyError
-        error "no such list: #{id}"
+        app_error "no such list: #{id}"
       end
       puts "◆→終了:#{@titles['list']}←◆"
       blank
@@ -178,7 +178,7 @@ module ReVIEW
           list_header(id, caption, lang)
         end
       rescue KeyError
-        error "no such list: #{id}"
+        app_error "no such list: #{id}"
       end
       puts "◆→終了:#{@titles['list']}←◆"
       blank
@@ -202,7 +202,7 @@ module ReVIEW
       if @chapter.image_bound?(id)
         puts "◆→#{@chapter.image(id).path}#{metrics}←◆"
       else
-        warn "image not bound: #{id}"
+        warn "image not bound: #{id}", location: location
         lines.each do |line|
           puts line
         end
@@ -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']
 
@@ -287,7 +335,25 @@ module ReVIEW
     def inline_fn(id)
       "【注#{@chapter.footnote(id).number}】"
     rescue KeyError
-      error "unknown footnote: #{id}"
+      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)
@@ -296,8 +362,9 @@ module ReVIEW
 
     def compile_kw(word, alt)
       if alt
-      then "★#{word}☆（#{alt.strip}）"
-      else "★#{word}☆"
+        "★#{word}☆（#{alt.strip}）"
+      else
+        "★#{word}☆"
       end
     end
 
@@ -380,8 +447,8 @@ module ReVIEW
     def inline_icon(id)
       begin
         "◆→画像 #{@chapter.image(id).path.sub(%r{\A\./}, '')}←◆"
-      rescue
-        warn "image not bound: #{id}"
+      rescue StandardError
+        warn "image not bound: #{id}", location: location
         "◆→画像 #{id}←◆"
       end
     end
@@ -425,7 +492,7 @@ module ReVIEW
     def inline_bib(id)
       %Q([#{@chapter.bibpaper(id).number}])
     rescue KeyError
-      error "unknown bib: #{id}"
+      app_error "unknown bib: #{id}"
     end
 
     def noindent
@@ -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
-        warn "image not bound: #{id}"
-        puts "◆→画像 #{id}←◆"
+      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?('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

data/lib/review/update.rb

@@ -1,5 +1,5 @@
 #
-# 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
@@ -165,7 +165,7 @@ module ReVIEW
 
       Dir.glob(File.join(dir, '*.yml')).sort.each do |yml|
         begin
-          config = YAML.load_file(yml)
+          config = YAMLLoader.safe_load_file(yml)
           if config['language'].present?
             language = config['language']
           end
@@ -226,9 +226,11 @@ module ReVIEW
 
     def check_own_files(dir)
       if File.exist?(File.join(dir, 'layouts/layout.tex.erb'))
+        # rubocop:disable Style/SoleNestedConditional
         unless confirm('** There is custom layouts/layout.tex.erb file. Updating may break to make PDF until you fix layout.tex.erb. Do you really proceed to update? **', [], nil)
           raise ApplicationError
         end
+        # rubocop:enable Style/SoleNestedConditional
       end
 
       if File.exist?(File.join(dir, 'review-ext.rb'))
@@ -238,7 +240,7 @@ module ReVIEW
 
     def update_version
       @config_ymls.each do |yml|
-        config = YAML.load_file(yml)
+        config = YAMLLoader.safe_load_file(yml)
         if config['review_version'].to_f.round(1) == TARGET_VERSION.to_f.round(1)
           next
         end
@@ -265,10 +267,12 @@ module ReVIEW
       target_rakefile = File.join(dir, 'Rakefile')
       if File.exist?(target_rakefile)
         if Digest::SHA256.hexdigest(File.read(target_rakefile)) != Digest::SHA256.hexdigest(File.read(master_rakefile))
+          # rubocop:disable Style/SoleNestedConditional
           if confirm('%s will be overridden with Re:VIEW version (%s). Do you really proceed?', ['Rakefile', master_rakefile])
             FileUtils.mv(target_rakefile, "#{target_rakefile}-old")
             FileUtils.cp(master_rakefile, target_rakefile)
           end
+          # rubocop:enable Style/SoleNestedConditional
         end
       else
         @logger.info t('new file %s is created.', [target_rakefile]) unless @force
@@ -278,12 +282,14 @@ module ReVIEW
       master_rakefile = File.join(@review_dir, 'samples/sample-book/src/lib/tasks/review.rake')
       target_rakefile = File.join(taskdir, 'review.rake')
       if File.exist?(target_rakefile)
+        # rubocop:disable Style/SoleNestedConditional
         if Digest::SHA256.hexdigest(File.read(target_rakefile)) != Digest::SHA256.hexdigest(File.read(master_rakefile))
           if confirm('%s will be overridden with Re:VIEW version (%s). Do you really proceed?', ['lib/tasks/review.rake', master_rakefile])
             FileUtils.mv(target_rakefile, "#{target_rakefile}-old")
             FileUtils.cp(master_rakefile, target_rakefile)
           end
         end
+        # rubocop:enable Style/SoleNestedConditional
       else
         @logger.info t('new file %s is created.', [target_rakefile]) unless @force
         FileUtils.cp(master_rakefile, target_rakefile)
@@ -292,11 +298,13 @@ module ReVIEW
 
     def update_epub_version
       @epub_ymls.each do |yml|
-        config = YAML.load_file(yml)
+        config = YAMLLoader.safe_load_file(yml)
         if config['epubversion'].present? && config['epubversion'].to_f < EPUB_VERSION.to_f
+          # rubocop:disable Style/SoleNestedConditional
           if confirm("%s: Update '%s' to '%s' from '%s'?", [File.basename(yml), 'epubversion', EPUB_VERSION, config['epubversion']])
             rewrite_yml(yml, 'epubversion', EPUB_VERSION)
           end
+          # rubocop:enable Style/SoleNestedConditional
         end
         if !config['htmlversion'].present? || config['htmlversion'].to_f >= HTML_VERSION.to_f
           next
@@ -310,7 +318,7 @@ module ReVIEW
 
     def update_locale
       @locale_ymls.each do |yml|
-        config = YAML.load_file(yml)
+        config = YAMLLoader.safe_load_file(yml)
         if !config['chapter_quote'].present? || config['chapter_quote'].scan('%s').size != 1
           next
         end
@@ -324,7 +332,7 @@ module ReVIEW
 
     def update_tex_parameters
       @tex_ymls.each do |yml|
-        config = YAML.load_file(yml)
+        config = YAMLLoader.safe_load_file(yml)
         unless config['texdocumentclass']
           next
         end
@@ -510,7 +518,7 @@ module ReVIEW
 
     def update_tex_command
       @tex_ymls.each do |yml|
-        config = YAML.load_file(yml)
+        config = YAMLLoader.safe_load_file(yml)
         if !config['texcommand'] || config['texcommand'] !~ /\s+-/
           next
         end
@@ -535,7 +543,7 @@ module ReVIEW
 
     def update_dvi_command
       @tex_ymls.each do |yml|
-        config = YAML.load_file(yml)
+        config = YAMLLoader.safe_load_file(yml)
         if !config['dvicommand'] || config['dvicommand'] !~ /\s+-/
           next
         end

data/lib/review/version.rb

@@ -1,3 +1,3 @@
 module ReVIEW
-  VERSION = '5.1.1'.freeze
+  VERSION = '5.4.0'.freeze
 end

data/lib/review/volumeprinter.rb

@@ -27,15 +27,15 @@ 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}.")
-        exit 1
-      end
-      I18n.setup(@book.config['language'])
-
       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
+
+        I18n.setup(@book.config['language'])
+
         @book.each_part do |part|
           if part.number
             print_chapter_volume(part)
@@ -44,7 +44,7 @@ module ReVIEW
             print_chapter_volume(chap)
           end
         end
-      rescue ReVIEW::FileNotFound, ReVIEW::CompileError, ReVIEW::ApplicationError => e
+      rescue ReVIEW::ConfigError, ReVIEW::FileNotFound, ReVIEW::CompileError, ReVIEW::ApplicationError => e
         @logger.error e.message
         exit 1
       end