review 4.0.0 → 5.1.1

data/lib/review/latexutils.rb

@@ -59,7 +59,7 @@ module ReVIEW
         end
       end
 
-      @metachars_re = /[#{Regexp.escape(@metachars.keys.join(''))}]/u
+      @metachars_re = /[#{Regexp.escape(@metachars.keys.join(''))}]/u # rubocop:disable Style/RedundantArgument
 
       @metachars_invert = @metachars.invert
     end
@@ -81,6 +81,14 @@ module ReVIEW
       str.gsub(/[@!|"]/) { |s| '"' + s }
     end
 
+    def escape_mendex_key(str)
+      str.gsub('"|', '｜').tr('{', '｛').tr('}', '｝')
+    end
+
+    def escape_mendex_display(str)
+      str.gsub('\{', '\reviewleftcurlybrace{}').gsub('\}', '\reviewrightcurlybrace{}')
+    end
+
     def escape_url(str)
       str.gsub(/[\#%]/) { |s| '\\' + s }
     end

data/lib/review/lineinput.rb

@@ -1,7 +1,33 @@
-require 'lineinput'
+#
+# Copyright (c) 2002-2020 Minero Aoki, Masayoshi Takahashi, Kenshi Muto
+#
+# This program is free software.
+# You can distribute/modify this program under the terms of
+# the GNU LGPL, Lesser General Public License version 2.1.
+#
+require 'review/exception'
 
 module ReVIEW
-  class LineInput < LineInput
+  class LineInput
+    INVALID_CHARACTER_PATTERN = /[\x00-\x08\x0b-\x0c\x0e-\x1f]/ # accept 0x09: TAB, 0x0a: LF, 0x0d: CR
+
+    attr_reader :lineno
+
+    def initialize(f)
+      @input = f
+      @buf = []
+      @lineno = 0
+      @eof_p = false
+    end
+
+    def inspect
+      "\#<#{self.class} file=#{@input.inspect} line=#{lineno}>"
+    end
+
+    def eof?
+      @eof_p
+    end
+
     def skip_comment_lines
       n = 0
       while line = gets
@@ -13,5 +39,89 @@ module ReVIEW
       end
       n
     end
+
+    def gets
+      unless @buf.empty?
+        @lineno += 1
+        return @buf.pop
+      end
+      return nil if @eof_p # to avoid ARGF blocking.
+
+      line = @input.gets
+      @eof_p = true unless line
+      @lineno += 1
+      invalid_char = lookup_invalid_char(line)
+      if invalid_char
+        raise SyntaxError, "found invalid control-sequence character (#{sprintf('%#x', invalid_char.codepoints[0])})."
+      end
+
+      line
+    end
+
+    def peek
+      line = gets
+      ungets(line) if line
+      line
+    end
+
+    def next?
+      peek ? true : false
+    end
+
+    def skip_blank_lines
+      n = 0
+      while line = gets
+        unless line.strip.empty?
+          ungets(line)
+          return n
+        end
+        n += 1
+      end
+      n
+    end
+
+    def each
+      while line = gets
+        yield line
+      end
+    end
+
+    def while_match(re)
+      while line = gets
+        unless re =~ line
+          ungets(line)
+          return
+        end
+        yield line
+      end
+      nil
+    end
+
+    def until_match(re)
+      while line = gets
+        if re =~ line
+          ungets(line)
+          return
+        end
+        yield line
+      end
+      nil
+    end
+
+    private
+
+    def ungets(line)
+      return unless line
+
+      @lineno -= 1
+      @buf.push(line)
+      line
+    end
+
+    def lookup_invalid_char(line)
+      if line =~ INVALID_CHARACTER_PATTERN
+        $&
+      end
+    end
   end
 end

data/lib/review/logger.rb

@@ -2,14 +2,53 @@ require 'logger'
 
 module ReVIEW
   class Logger < ::Logger
-    def initialize(io = STDERR, progname: '--')
+    def initialize(io = $stderr, progname: '--')
       super(io, progname: progname)
       self.formatter = ->(severity, _datetime, name, msg) { "#{severity} #{name}: #{msg}\n" }
     end
+
+    def ttylogger?
+      nil
+    end
+
+    def success(_log)
+      # empty (for backward compatibility)
+    end
   end
 
-  def self.logger
-    @logger ||= ReVIEW::Logger.new(STDERR, progname: File.basename($PROGRAM_NAME, '.*'))
+  begin
+    require 'tty-logger'
+    class TTYLogger < ::TTY::Logger
+      def ttylogger?
+        true
+      end
+    end
+  rescue LoadError
+    nil
+  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
   end
 
   def self.logger=(logger)

data/lib/review/makerhelper.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2012-2018 Yuto HAYAMIZU, Kenshi Muto
+# Copyright (c) 2012-2020 Yuto HAYAMIZU, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -8,15 +8,19 @@
 require 'pathname'
 require 'fileutils'
 require 'yaml'
-require 'shellwords'
+
+begin
+  require 'cgi/escape'
+rescue
+  require 'cgi/util'
+end
 
 module ReVIEW
   module MakerHelper
-    # Return review/bin directory
-    def bindir
-      Pathname.new("#{Pathname.new(__FILE__).realpath.dirname}/../../bin").realpath
+    def h(str)
+      CGI.escapeHTML(str)
     end
-    module_function :bindir
+    module_function :h
 
     # Copy image files under from_dir to to_dir recursively
     # ==== Args
@@ -40,6 +44,7 @@ module ReVIEW
       Dir.open(from_dir) do |dir|
         dir.each do |fname|
           next if fname =~ /^\./
+
           if FileTest.directory?("#{from_dir}/#{fname}")
             image_files += copy_images_to_dir("#{from_dir}/#{fname}", "#{to_dir}/#{fname}", options)
           else
@@ -48,6 +53,7 @@ module ReVIEW
             is_converted = false
             (options[:convert] || {}).each do |orig_type, conv_type|
               next unless /\.#{orig_type}$/ =~ fname
+
               is_converted = system("convert #{from_dir}/#{fname} #{to_dir}/#{fname}.#{conv_type}")
               image_files << "#{from_dir}/#{fname}.#{conv_type}"
             end
@@ -65,186 +71,5 @@ module ReVIEW
       image_files
     end
     module_function :copy_images_to_dir
-
-    def cleanup_mathimg(path = '_review_math')
-      math_dir = "./#{@config['imagedir']}/#{path}"
-      if @config['imgmath'] && Dir.exist?(math_dir)
-        FileUtils.rm_rf(math_dir)
-      end
-    end
-
-    def default_imgmath_preamble
-      <<-EOB
-\\documentclass[uplatex,a3paper,landscape]{jsarticle}
-\\usepackage[deluxe,uplatex]{otf}
-\\usepackage[T1]{fontenc}
-\\usepackage{textcomp}
-\\usepackage{lmodern}
-\\usepackage[dvipdfmx]{graphicx}
-\\usepackage[dvipdfmx,table]{xcolor}
-\\usepackage[utf8]{inputenc}
-\\usepackage{ascmac}
-\\usepackage{float}
-\\usepackage{alltt}
-\\usepackage{amsmath}
-\\usepackage{amssymb}
-\\usepackage{amsfonts}
-\\usepackage{anyfontsize}
-\\usepackage{bm}
-\\pagestyle{empty}
-% \\setpaperwidth{1000mm}
-    EOB
-    end
-
-    def make_math_images(math_dir)
-      fontsize = @config['imgmath_options']['fontsize'].to_f
-      lineheight = @config['imgmath_options']['lineheight'].to_f
-
-      texsrc = default_imgmath_preamble
-      if @config['imgmath_options']['preamble_file'] && File.readable?(@config['imgmath_options']['preamble_file'])
-        texsrc = File.read(@config['imgmath_options']['preamble_file'])
-      end
-
-      texsrc << <<-EOB
-\\begin{document}
-\\fontsize{#{fontsize}}{#{lineheight}}\\selectfont
-\\input{__IMGMATH_BODY__}
-\\end{document}
-EOB
-
-      math_dir = File.realpath(math_dir)
-      Dir.mktmpdir do |tmpdir|
-        FileUtils.cp([File.join(math_dir, '__IMGMATH_BODY__.tex'),
-                      File.join(math_dir, '__IMGMATH_BODY__.map')],
-                     tmpdir)
-        tex_path = File.join(tmpdir, '__IMGMATH__.tex')
-        File.write(tex_path, texsrc)
-
-        begin
-          case @config['imgmath_options']['converter']
-          when 'pdfcrop'
-            make_math_images_pdfcrop(tmpdir, tex_path, math_dir)
-          when 'dvipng'
-            make_math_images_dvipng(tmpdir, tex_path, math_dir)
-          else
-            error "unknown math converter error. imgmath_options/converter parameter should be 'pdfcrop' or 'dvipng'."
-          end
-        rescue CompileError
-          FileUtils.cp([tex_path,
-                        File.join(File.dirname(tex_path), '__IMGMATH__.log')],
-                       math_dir)
-          error "LaTeX math compile error. See #{math_dir}/__IMGMATH__.log for details."
-        end
-      end
-      FileUtils.rm_f([File.join(math_dir, '__IMGMATH_BODY__.tex'),
-                      File.join(math_dir, '__IMGMATH_BODY__.map')])
-    end
-
-    def make_math_images_pdfcrop(dir, tex_path, math_dir)
-      # rubocop:disable Metrics/BlockLength
-      Dir.chdir(dir) do
-        dvi_path = '__IMGMATH__.dvi'
-        pdf_path = '__IMGMATH__.pdf'
-        out, status = Open3.capture2e(*[@config['texcommand'], @config['texoptions'].shellsplit, tex_path].flatten.compact)
-        if !status.success? || (!File.exist?(dvi_path) && !File.exist?(pdf_path))
-          raise CompileError
-        end
-        if File.exist?(dvi_path)
-          out, status = Open3.capture2e(*[@config['dvicommand'], @config['dvioptions'].shellsplit, dvi_path].flatten.compact)
-          if !status.success? || !File.exist?(pdf_path)
-            warn "error in #{@config['dvicommand']}. Error log:\n#{out}"
-            raise CompileError
-          end
-        end
-        args = @config['imgmath_options']['pdfcrop_cmd'].shellsplit
-        args.map! do |m|
-          m.sub('%i', pdf_path).
-            sub('%o', '__IMGMATH__pdfcrop.pdf')
-        end
-        out, status = Open3.capture2e(*args)
-        unless status.success?
-          warn "error in pdfcrop. Error log:\n#{out}"
-          raise CompileError
-        end
-        pdf_path = '__IMGMATH__pdfcrop.pdf'
-        pdf_path2 = pdf_path
-
-        File.open('__IMGMATH_BODY__.map') do |f|
-          page = 0
-          f.each_line do |key|
-            page += 1
-            key.chomp!
-            if File.exist?(File.join(math_dir, "_gen_#{key}.#{@config['imgmath_options']['format']}"))
-              # made already
-              next
-            end
-
-            if @config['imgmath_options']['extract_singlepage']
-              # if extract_singlepage = true, split each page
-              args = @config['imgmath_options']['pdfextract_cmd'].shellsplit
-
-              args.map! do |m|
-                m.sub('%i', pdf_path).
-                  sub('%o', "__IMGMATH__pdfcrop_p#{page}.pdf").
-                  sub('%O', "__IMGMATH__pdfcrop_p#{page}").
-                  sub('%p', page.to_s)
-              end
-              out, status = Open3.capture2e(*args)
-              unless status.success?
-                warn "error in pdf extracting. Error log:\n#{out}"
-                raise CompileError
-              end
-
-              pdf_path2 = "__IMGMATH__pdfcrop_p#{page}.pdf"
-            end
-
-            args = @config['imgmath_options']['pdfcrop_pixelize_cmd'].shellsplit
-            args.map! do |m|
-              m.sub('%i', pdf_path2).
-                sub('%t', @config['imgmath_options']['format']).
-                sub('%o', File.join(math_dir, "_gen_#{key}.#{@config['imgmath_options']['format']}")).
-                sub('%O', File.join(math_dir, "_gen_#{key}")).
-                sub('%p', page.to_s)
-            end
-            out, status = Open3.capture2e(*args)
-            unless status.success?
-              warn "error in pdf pixelizing. Error log:\n#{out}"
-              raise CompileError
-            end
-          end
-        end
-      end
-      # rubocop:enable Metrics/BlockLength
-    end
-
-    def make_math_images_dvipng(dir, tex_path, math_dir)
-      Dir.chdir(dir) do
-        dvi_path = '__IMGMATH__.dvi'
-        out, status = Open3.capture2e(*[@config['texcommand'], @config['texoptions'].shellsplit, tex_path].flatten.compact)
-        if !status.success? || !File.exist?(dvi_path)
-          raise CompileError
-        end
-
-        File.open('__IMGMATH_BODY__.map') do |f|
-          page = 0
-          f.each_line do |key|
-            page += 1
-            key.chomp!
-            args = @config['imgmath_options']['dvipng_cmd'].shellsplit
-            args.map! do |m|
-              m.sub('%i', dvi_path).
-                sub('%o', File.join(math_dir, "_gen_#{key}.#{@config['imgmath_options']['format']}")).
-                sub('%O', File.join(math_dir, "_gen_#{key}")).
-                sub('%p', page.to_s)
-            end
-            out, status = Open3.capture2e(*args)
-            unless status.success?
-              warn "error in dvipng. Error log:\n#{out}"
-              raise CompileError
-            end
-          end
-        end
-      end
-    end
   end
 end

data/lib/review/markdownbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2019 KADO Masanori, Masayoshi Takahashi, Kenshi Muto
+# Copyright (c) 2013-2020 KADO Masanori, Masayoshi Takahashi, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -155,10 +155,28 @@ module ReVIEW
       puts %Q(<div class="#{type}">)
       puts %Q(<p class="caption">#{compile_inline(caption)}</p>) if caption.present?
       blocked_lines = split_paragraph(lines)
-      puts blocked_lines.join("\n")
+      puts blocked_lines.join("\n\n")
       puts '</div>'
     end
 
+    CAPTION_TITLES.each do |name|
+      class_eval %Q(
+        def #{name}_begin(caption = nil)
+          check_nested_minicolumn
+          @doc_status[:minicolumn] = '#{name}'
+          puts %Q(<div class="#{name}">)
+          if caption.present?
+            puts %Q(<p class="caption">\#{compile_inline(caption)}</p>)
+          end
+        end
+
+        def #{name}_end
+          puts '</div>'
+          @doc_status[:minicolumn] = nil
+        end
+      ), __FILE__, __LINE__ - 14
+    end
+
     def hr
       puts '----'
     end
@@ -206,6 +224,14 @@ module ReVIEW
       "<u>#{str}</u>"
     end
 
+    def inline_ins(str)
+      "<ins>#{str}</ins>"
+    end
+
+    def inline_del(str)
+      "~~#{str}~~"
+    end
+
     def image_image(id, caption, _metric)
       blank
       puts "![#{compile_inline(caption)}](#{@chapter.image(id).path.sub(%r{\A\./}, '')})"
@@ -226,6 +252,28 @@ module ReVIEW
       "<!-- DTP:#{str} -->"
     end
 
+    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
+      if @book.config['chapterlink']
+        if @chapter == chap
+          anchor = 'h' + n.tr('.', '-')
+          %Q(<a href="##{anchor}">#{str}</a>)
+        else
+          warn 'MARKDOWNBuilder does not support links to other chapters'
+          str
+        end
+      else
+        str
+      end
+    rescue KeyError
+      error "unknown headline: #{id}"
+    end
+
     def indepimage(_lines, id, caption = '', _metric = nil)
       blank
       puts "![#{compile_inline(caption)}](#{@chapter.image(id).path.sub(%r{\A\./}, '')})"
@@ -340,6 +388,7 @@ module ReVIEW
 
     def comment(lines, comment = nil)
       return unless @book.config['draft']
+
       lines ||= []
       unless comment.blank?
         lines.unshift(comment)