review 4.0.0 → 5.1.1

data/lib/review/init.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2018-2019 Masanori Kado, Masayoshi Takahashi, Kenshi Muto
+# Copyright (c) 2018-2021 Masanori Kado, Masayoshi Takahashi, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -82,6 +82,9 @@ module ReVIEW
       opts.on('', '--epub-version VERSION', 'define EPUB version.') do |version|
         @epub_version = version
       end
+      opts.on('', '--without-config-comment', "don't include comments in config.yml.") do
+        @without_config_comment = true
+      end
       opts.on('', '--without-doc', "don't generate doc files.") do
         @without_doc = true
       end
@@ -111,9 +114,7 @@ module ReVIEW
         exit 1
       end
 
-      initdir = File.expand_path(args[0])
-
-      initdir
+      File.expand_path(args[0])
     end
 
     def generate_dir(dir)
@@ -132,8 +133,7 @@ module ReVIEW
     end
 
     def generate_catalog_file(dir)
-      File.open(File.join(dir, 'catalog.yml'), 'w') do |file|
-        file.write <<-EOS
+      File.write(File.join(dir, 'catalog.yml'), <<-EOS)
 PREDEF:
 
 CHAPS:
@@ -144,7 +144,6 @@ APPENDIX:
 POSTDEF:
 
 EOS
-      end
     end
 
     def generate_images_dir(dir)
@@ -176,6 +175,10 @@ EOS
         content.gsub!(/^#\s*texdocumentclass:.*$/, %Q(texdocumentclass: ["#{@template}", "#{@tex_documentclass_opts[@template]}"]))
       end
 
+      if @without_config_comment
+        content = content.split("\n").delete_if { |l| l.strip.start_with?('#') || l.strip.empty? }.join("\n")
+      end
+
       File.open(File.join(dir, 'config.yml'), 'w') { |f| f.write content }
       if @webui && !@web_result[2].empty?
         File.open(File.join(dir, 'config-ebook.yml'), 'w') do |f|
@@ -206,9 +209,9 @@ EOT
       FileUtils.cp(Dir.glob(File.join(tdir, '*.*')), texmacrodir)
 
       if @template == 'review-jsbook'
-        # provide jsbook from vendor/. current version is 2018/06/23
+        # provide jsbook from vendor/. current version is 2020/10/09
         FileUtils.cp(File.join(@review_dir, 'vendor/jsclasses/jsbook.cls'), File.join(texmacrodir, 'jsbook.cls'))
-        # provide gentombow from vendor/. current version is 2018/08/30 v0.9j
+        # provide gentombow from vendor/. current version is 2019/07/21 v0.9k
         FileUtils.cp(File.join(@review_dir, 'vendor/gentombow/gentombow.sty'), File.join(texmacrodir, 'gentombow.sty'))
       end
     end
@@ -216,13 +219,11 @@ EOT
     def generate_rakefile(dir)
       FileUtils.mkdir_p(File.join(dir, 'lib/tasks'))
 
-      File.open(File.join(dir, 'Rakefile'), 'w') do |file|
-        file.write <<-EOS
+      File.write(File.join(dir, 'Rakefile'), <<-EOS)
 Dir.glob('lib/tasks/*.rake').sort.each do |file|
   load(file)
 end
 EOS
-      end
 
       FileUtils.cp(File.join(@review_dir, 'samples/sample-book/src/lib/tasks/review.rake'),
                    File.join(dir, 'lib/tasks/review.rake'))
@@ -233,14 +234,12 @@ EOS
     end
 
     def generate_gemfile(dir)
-      File.open(File.join(dir, 'Gemfile'), 'w') do |file|
-        file.write <<-EOS
+      File.write(File.join(dir, 'Gemfile'), <<-EOS)
 source 'https://rubygems.org'
 
 gem 'rake'
 gem 'review', '#{ReVIEW::VERSION}'
 EOS
-      end
     end
 
     def generate_doc(dir)
@@ -287,12 +286,12 @@ EOS
       begin
         Zip::File.open(filename) do |zip|
           zip.each do |entry|
-            fname = entry.name.gsub('\\', '/')
+            fname = entry.name.tr('\\', '/')
             if fname =~ /__MACOSX/ || fname =~ /\.DS_Store/
               next
             end
 
-            if fname =~ %r{\A/} || fname =~ /\.\./ # simple fool proof
+            if fname.start_with?('/') || fname =~ /\.\./ # simple fool proof
               made = nil
               break
             end
@@ -335,7 +334,7 @@ EOS
       # validation
       if @web_result
         @web_result.each do |s|
-          if s !~ /\A[a-z0-9=_,\.-]*\Z/i
+          if s !~ /\A[a-z0-9=_,.-]*\Z/i
             @web_result = nil
             break
           end

data/lib/review/latexbox.rb

@@ -0,0 +1,58 @@
+# Copyright (c) 2021 Kenshi Muto
+#
+# This program is free software.
+# You can distribute or modify this program under the terms of
+# the GNU LGPL, Lesser General Public License version 2.1.
+# For details of the GNU LGPL, see the file "COPYING".
+#
+require 'review/logger'
+module ReVIEW
+  class LaTeXBox
+    def initialize
+      @logger = ReVIEW.logger
+    end
+
+    def tcbox(config)
+      ret = ''
+
+      %w[column note memo tip info warning important caution notice].each do |name|
+        if config['pdfmaker'].nil? || config['pdfmaker']['boxsetting'].nil? ||
+           config['pdfmaker']['boxsetting'][name].nil? ||
+           config['pdfmaker']['boxsetting'][name]['style'].nil?
+          next
+        end
+
+        options = '[]'
+        options_with_caption = '[]'
+        if config['pdfmaker']['boxsetting'][name]['options']
+          options = "[#{config['pdfmaker']['boxsetting'][name]['options']}]"
+          options_with_caption = options
+        end
+
+        if config['pdfmaker']['boxsetting'][name]['options_with_caption']
+          options_with_caption = "[#{config['pdfmaker']['boxsetting'][name]['options_with_caption']}]"
+        end
+
+        ret << <<EOT
+\\renewenvironment{review#{name}}[1][]{%
+  \\csdef{rv@tmp@withcaption}{true}
+  \\notblank{##1}{
+    \\begin{rv@#{config['pdfmaker']['boxsetting'][name]['style']}@caption}{##1}#{options_with_caption}
+   }{
+    \\csundef{rv@tmp@withcaption}
+    \\begin{rv@#{config['pdfmaker']['boxsetting'][name]['style']}@nocaption}#{options}
+   }
+}{
+  \\ifcsdef{rv@tmp@withcaption}{
+    \\end{rv@#{config['pdfmaker']['boxsetting'][name]['style']}@caption}
+  }{
+    \\end{rv@#{config['pdfmaker']['boxsetting'][name]['style']}@nocaption}
+  }
+}
+EOT
+      end
+
+      ret
+    end
+  end
+end

data/lib/review/latexbuilder.rb

@@ -1,6 +1,6 @@
 # Copyright (c) 2002-2007 Minero Aoki
 #               2008-2009 Minero Aoki, Kenshi Muto
-#               2010-2019 Minero Aoki, Kenshi Muto, TAKAHASHI Masayoshi
+#               2010-2021 Minero Aoki, Kenshi Muto, TAKAHASHI Masayoshi
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -51,6 +51,7 @@ module ReVIEW
         @index_db = load_idxdb(@book.config['pdfmaker']['makeindex_dic'])
       end
       return true unless @book.config['pdfmaker']['makeindex_mecab']
+
       begin
         begin
           require 'MeCab'
@@ -60,7 +61,7 @@ module ReVIEW
         require 'nkf'
         @index_mecab = MeCab::Tagger.new(@book.config['pdfmaker']['makeindex_mecab_opts'])
       rescue LoadError
-        error 'not found MeCab'
+        warn 'not found MeCab'
       end
     end
 
@@ -100,7 +101,21 @@ module ReVIEW
       if @chapter.is_a?(ReVIEW::Book::Part) && !@book.config.check_version('2', exception: false)
         puts '\end{reviewpart}'
       end
-      @output.string
+      solve_nest(@output.string)
+    end
+
+    def solve_nest(s)
+      check_nest
+      s.gsub("\\end{description}\n\n\x01→dl←\x01\n", "\n").
+        gsub("\x01→/dl←\x01", "\\end{description}←END\x01").
+        gsub("\\end{itemize}\n\n\x01→ul←\x01\n", "\n").
+        gsub("\x01→/ul←\x01", "\\end{itemize}←END\x01").
+        gsub("\\end{enumerate}\n\n\x01→ol←\x01\n", "\n").
+        gsub("\x01→/ol←\x01", "\\end{enumerate}←END\x01").
+        gsub("\\end{description}←END\x01\n\n\\begin{description}", '').
+        gsub("\\end{itemize}←END\x01\n\n\\begin{itemize}", '').
+        gsub("\\end{enumerate}←END\x01\n\n\\begin{enumerate}", '').
+        gsub("←END\x01", '')
     end
 
     HEADLINE = {
@@ -166,10 +181,10 @@ module ReVIEW
     end
 
     def nodisp_begin(level, _label, caption)
-      if @output.pos != 0
-        blank
-      else
+      if @output.pos == 0
         puts macro('clearpage')
+      else
+        blank
       end
       puts macro('addcontentsline', 'toc', HEADLINE[level], compile_inline(caption))
       # FIXME: headings
@@ -212,7 +227,53 @@ module ReVIEW
       @doc_status[:column] = nil
     end
 
+    def common_block_begin(type, caption = nil)
+      check_nested_minicolumn
+      if @book.config.check_version('2', exception: false)
+        type = 'minicolumn'
+      end
+
+      @doc_status[:minicolumn] = type
+      print "\\begin{review#{type}}"
+
+      @doc_status[:caption] = true
+      if @book.config.check_version('2', exception: false)
+        puts
+        if caption.present?
+          puts "\\reviewminicolumntitle{#{compile_inline(caption)}}"
+        end
+      else
+        if caption.present?
+          print "[#{compile_inline(caption)}]"
+        end
+        puts
+      end
+      @doc_status[:caption] = nil
+    end
+
+    def common_block_end(type)
+      if @book.config.check_version('2', exception: false)
+        type = 'minicolumn'
+      end
+
+      puts "\\end{review#{type}}"
+      @doc_status[:minicolumn] = nil
+    end
+
+    CAPTION_TITLES.each do |name|
+      class_eval %Q(
+        def #{name}_begin(caption = nil)
+          common_block_begin('#{name}', caption)
+        end
+
+        def #{name}_end
+          common_block_end('#{name}')
+        end
+      ), __FILE__, __LINE__ - 8
+    end
+
     def captionblock(type, lines, caption)
+      check_nested_minicolumn
       if @book.config.check_version('2', exception: false)
         type = 'minicolumn'
       end
@@ -274,6 +335,7 @@ module ReVIEW
       blank
       puts '\begin{enumerate}'
       return true unless @ol_num
+
       puts "\\setcounter{enumi}{#{@ol_num - 1}}"
       @ol_num = nil
     end
@@ -299,8 +361,7 @@ module ReVIEW
     end
 
     def dt(str)
-      str.sub!(/\[/) { '\lbrack{}' }
-      str.sub!(/\]/) { '\rbrack{}' }
+      str = str.gsub('[', '\lbrack{}').gsub(']', '\rbrack{}')
       puts '\item[' + str + '] \mbox{} \\\\'
     end
 
@@ -404,18 +465,19 @@ module ReVIEW
 
     def common_code_block(id, lines, command, caption, _lang)
       @doc_status[:caption] = true
+      captionstr = nil
       unless @book.config.check_version('2', exception: false)
         puts '\\begin{reviewlistblock}'
       end
       if caption.present?
         if command =~ /emlist/ || command =~ /cmd/ || command =~ /source/
-          puts macro(command + 'caption', compile_inline(caption))
+          captionstr = macro(command + 'caption', compile_inline(caption))
         else
           begin
             if get_chap.nil?
-              puts macro('reviewlistcaption', "#{I18n.t('list')}#{I18n.t('format_number_header_without_chapter', [@chapter.list(id).number])}#{I18n.t('caption_prefix')}#{compile_inline(caption)}")
+              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
-              puts macro('reviewlistcaption', "#{I18n.t('list')}#{I18n.t('format_number_header', [get_chap, @chapter.list(id).number])}#{I18n.t('caption_prefix')}#{compile_inline(caption)}")
+              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
           rescue KeyError
             error "no such list: #{id}"
@@ -423,6 +485,11 @@ module ReVIEW
         end
       end
       @doc_status[:caption] = nil
+
+      if caption_top?('list') && captionstr
+        puts captionstr
+      end
+
       body = ''
       lines.each_with_index do |line, idx|
         body.concat(yield(line, idx))
@@ -430,6 +497,11 @@ module ReVIEW
       puts macro('begin', command)
       print body
       puts macro('end', command)
+
+      if !caption_top?('list') && captionstr
+        puts captionstr
+      end
+
       unless @book.config.check_version('2', exception: false)
         puts '\\end{reviewlistblock}'
       end
@@ -482,10 +554,20 @@ module ReVIEW
     def image_header(id, caption)
     end
 
+    def parse_metric(type, metric)
+      s = super(type, metric)
+      if @book.config['pdfmaker']['use_original_image_size'] && s.empty? && !metric.present?
+        return ' ' # pass empty to \reviewincludegraphics
+      end
+
+      s
+    end
+
     def handle_metric(str)
-      if @book.config['image_scale2width'] && str =~ /\Ascale=([\d.]+)\Z/
+      if @book.config['pdfmaker']['image_scale2width'] && str =~ /\Ascale=([\d.]+)\Z/
         return "width=#{$1}\\maxwidth"
       end
+
       str
     end
 
@@ -493,11 +575,25 @@ module ReVIEW
       array.join(',')
     end
 
-    def image_image(id, caption, metric)
+    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 << macro('label', image_label(id))
+      @doc_status[:caption] = nil
+
       metrics = parse_metric('latex', metric)
       # image is always bound here
       puts "\\begin{reviewimage}%%#{id}"
 
+      if caption_top?('image')
+        puts captionstr
+      end
+
       command = 'reviewincludegraphics'
       if @book.config.check_version('2', exception: false)
         command = 'includegraphics'
@@ -508,15 +604,11 @@ module ReVIEW
       else
         puts "\\#{command}[width=\\maxwidth]{#{@chapter.image(id).path}}"
       end
-      @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?
+      unless caption_top?('image')
+        puts captionstr
       end
-      @doc_status[:caption] = nil
-      puts macro('label', image_label(id))
+
       puts '\end{reviewimage}'
     end
 
@@ -571,7 +663,8 @@ module ReVIEW
     end
     private :bib_label
 
-    def column_label(id, chapter = @chapter)
+    def column_label(id, chapter = nil)
+      chapter ||= @chapter
       filename = chapter.id
       num = chapter.column(id).number
       "column:#{filename}:#{num}"
@@ -581,9 +674,21 @@ module ReVIEW
     def indepimage(lines, id, caption = nil, metric = nil)
       metrics = parse_metric('latex', metric)
 
+      captionstr = nil
+      if caption.present?
+        @doc_status[:caption] = true
+        captionstr = macro('reviewindepimagecaption',
+                           %Q(#{I18n.t('numberless_image')}#{I18n.t('caption_prefix')}#{compile_inline(caption)}))
+        @doc_status[:caption] = nil
+      end
+
       if @chapter.image(id).path
         puts "\\begin{reviewimage}%%#{id}"
 
+        if caption_top?('image') && captionstr
+          puts captionstr
+        end
+
         command = 'reviewincludegraphics'
         if @book.config.check_version('2', exception: false)
           command = 'includegraphics'
@@ -597,18 +702,15 @@ module ReVIEW
       else
         warn "image not bound: #{id}"
         puts '\begin{reviewdummyimage}'
-        puts "--[[path = #{id} (#{existence(id)})]]--"
+        puts "--[[path = #{escape(id)} (#{existence(id)})]]--"
         lines.each do |line|
           puts detab(line.rstrip)
         end
       end
 
-      @doc_status[:caption] = true
-      if caption.present?
-        puts macro('reviewindepimagecaption',
-                   %Q(#{I18n.t('numberless_image')}#{I18n.t('caption_prefix')}#{compile_inline(caption)}))
+      if !caption_top?('image') && captionstr
+        puts captionstr
       end
-      @doc_status[:caption] = nil
 
       if @chapter.image(id).path
         puts '\end{reviewimage}'
@@ -630,7 +732,9 @@ module ReVIEW
 
       sepidx, rows = parse_table_rows(lines)
       begin
-        table_header(id, caption) if caption.present?
+        if caption_top?('table') && caption.present?
+          table_header(id, caption)
+        end
       rescue KeyError
         error "no such table: #{id}"
       end
@@ -638,6 +742,9 @@ module ReVIEW
       table_rows(sepidx, rows)
       table_end
       if caption.present?
+        unless caption_top?('table')
+          table_header(id, caption)
+        end
         puts '\end{table}'
       end
       blank
@@ -800,12 +907,16 @@ module ReVIEW
         return
       end
 
+      captionstr = nil
       begin
         if caption.present?
           puts "\\begin{table}[h]%%#{id}"
           @doc_status[:caption] = true
-          puts macro('reviewimgtablecaption', compile_inline(caption))
+          captionstr = macro('reviewimgtablecaption', compile_inline(caption))
           @doc_status[:caption] = nil
+          if caption_top?('table')
+            puts captionstr
+          end
         end
         puts macro('label', table_label(id))
       rescue ReVIEW::KeyError
@@ -814,6 +925,9 @@ module ReVIEW
       imgtable_image(id, caption, metric)
 
       if caption.present?
+        unless caption_top?('table')
+          puts captionstr
+        end
         puts '\end{table}'
       end
       blank
@@ -853,22 +967,31 @@ module ReVIEW
 
     def texequation(lines, id = nil, caption = '')
       blank
+      captionstr = nil
 
       if id
         puts macro('begin', 'reviewequationblock')
         if get_chap.nil?
-          puts macro('reviewequationcaption', "#{I18n.t('equation')}#{I18n.t('format_number_header_without_chapter', [@chapter.equation(id).number])}#{I18n.t('caption_prefix')}#{compile_inline(caption)}")
+          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
-          puts macro('reviewequationcaption', "#{I18n.t('equation')}#{I18n.t('format_number_header', [get_chap, @chapter.equation(id).number])}#{I18n.t('caption_prefix')}#{compile_inline(caption)}")
+          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
       end
 
+      if caption_top?('equation') && captionstr
+        puts captionstr
+      end
+
       puts macro('begin', 'equation*')
       lines.each do |line|
         puts line
       end
       puts macro('end', 'equation*')
 
+      if !caption_top?('equation') && captionstr
+        puts captionstr
+      end
+
       if id
         puts macro('end', 'reviewequationblock')
       end
@@ -888,6 +1011,7 @@ module ReVIEW
 
     def direct(lines, fmt)
       return unless fmt == 'latex'
+
       lines.each do |line|
         puts line
       end
@@ -895,6 +1019,7 @@ module ReVIEW
 
     def comment(lines, comment = nil)
       return true unless @book.config['draft']
+
       lines ||= []
       unless comment.blank?
         lines.unshift(escape(comment))
@@ -926,7 +1051,7 @@ module ReVIEW
     def inline_chapref(id)
       title = super
       if @book.config['chapterlink']
-        "\\hyperref[chap:#{id}]{#{title}}"
+        "\\reviewchapref{#{title}}{chap:#{id}}"
       else
         title
       end
@@ -937,7 +1062,7 @@ module ReVIEW
 
     def inline_chap(id)
       if @book.config['chapterlink']
-        "\\hyperref[chap:#{id}]{#{@book.chapter_index.number(id)}}"
+        "\\reviewchapref{#{@book.chapter_index.number(id)}}{chap:#{id}}"
       else
         @book.chapter_index.number(id)
       end
@@ -949,7 +1074,7 @@ module ReVIEW
     def inline_title(id)
       title = super
       if @book.config['chapterlink']
-        "\\hyperref[chap:#{id}]{#{title}}"
+        "\\reviewchapref{#{title}}{chap:#{id}}"
       else
         title
       end
@@ -1019,7 +1144,7 @@ module ReVIEW
     def inline_fn(id)
       if @book.config['footnotetext']
         macro("footnotemark[#{@chapter.footnote(id).number}]", '')
-      elsif @doc_status[:caption] || @doc_status[:table] || @doc_status[:column]
+      elsif @doc_status[:caption] || @doc_status[:table] || @doc_status[:column] || @doc_status[:dt]
         @foottext[id] = @chapter.footnote(id).number
         macro('protect\\footnotemark', '')
       else
@@ -1112,6 +1237,10 @@ module ReVIEW
       end
     end
 
+    def inline_ins(str)
+      macro('reviewinsert', escape(str))
+    end
+
     def inline_del(str)
       macro('reviewstrike', escape(str))
     end
@@ -1144,7 +1273,7 @@ module ReVIEW
         str = I18n.t('hd_quote_without_number', compile_inline(chap.headline(id).caption))
       end
       if @book.config['chapterlink']
-        anchor = n.gsub(/\./, '-')
+        anchor = n.tr('.', '-')
         macro('reviewsecref', str, sec_label(anchor))
       else
         str
@@ -1159,7 +1288,7 @@ module ReVIEW
       error "unknown column: #{id}"
     end
 
-    def inline_raw(str)
+    def inline_raw(str) # rubocop:disable Lint/UselessMethodDefinition
       super(str)
     end
 
@@ -1242,22 +1371,23 @@ module ReVIEW
     end
 
     def index(str)
+      # XXX: mendex/upmendex specific
       sa = str.split('<<>>')
 
       sa.map! do |item|
         if @index_db[item]
-          escape_index(escape(@index_db[item])) + '@' + escape_index(escape(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_index(escape(item))
-            if esc_item != item
-              "#{escape_index(item)}@#{esc_item}"
-            else
+            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
           else
             yomi = NKF.nkf('-w --hiragana', @index_mecab.parse(item).force_encoding('UTF-8').chomp)
-            escape_index(escape(yomi)) + '@' + escape_index(escape(item))
+            escape_mendex_key(escape_index(yomi)) + '@' + escape_mendex_display(escape_index(escape(item)))
           end
         end
       end