review 3.2.0 → 4.0.0

data/lib/review/lineinput.rb

@@ -6,7 +6,7 @@ module ReVIEW
       n = 0
       while line = gets
         unless line.strip =~ /\A\#@/
-          ungets line
+          ungets(line)
           return n
         end
         n += 1

data/lib/review/logger.rb

@@ -2,18 +2,14 @@ require 'logger'
 
 module ReVIEW
   class Logger < ::Logger
-    def initialize(*logdev)
-      if logdev.empty?
-        super(STDERR)
-        self.formatter = ->(severity, _datetime, _progname, msg) { "#{severity}: #{msg}\n" }
-      else
-        super
-      end
+    def initialize(io = STDERR, progname: '--')
+      super(io, progname: progname)
+      self.formatter = ->(severity, _datetime, name, msg) { "#{severity} #{name}: #{msg}\n" }
     end
   end
 
   def self.logger
-    @logger ||= ReVIEW::Logger.new
+    @logger ||= ReVIEW::Logger.new(STDERR, progname: File.basename($PROGRAM_NAME, '.*'))
   end
 
   def self.logger=(logger)

data/lib/review/makerhelper.rb

@@ -55,7 +55,7 @@ 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
+              FileUtils.cp("#{from_dir}/#{fname}", to_dir)
               image_files << "#{from_dir}/#{fname}"
             end
           end
@@ -66,8 +66,8 @@ module ReVIEW
     end
     module_function :copy_images_to_dir
 
-    def cleanup_mathimg
-      math_dir = "./#{@config['imagedir']}/_review_math"
+    def cleanup_mathimg(path = '_review_math')
+      math_dir = "./#{@config['imagedir']}/#{path}"
       if @config['imgmath'] && Dir.exist?(math_dir)
         FileUtils.rm_rf(math_dir)
       end
@@ -141,6 +141,7 @@ EOB
     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'
@@ -155,7 +156,6 @@ EOB
             raise CompileError
           end
         end
-
         args = @config['imgmath_options']['pdfcrop_cmd'].shellsplit
         args.map! do |m|
           m.sub('%i', pdf_path).
@@ -201,6 +201,7 @@ EOB
             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)
@@ -213,6 +214,7 @@ EOB
           end
         end
       end
+      # rubocop:enable Metrics/BlockLength
     end
 
     def make_math_images_dvipng(dir, tex_path, math_dir)

data/lib/review/markdownbuilder.rb

@@ -1,3 +1,5 @@
+# Copyright (c) 2013-2019 KADO Masanori, Masayoshi Takahashi, 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.
@@ -50,11 +52,11 @@ module ReVIEW
 
     def paragraph(lines)
       if @noindent
-        puts %Q(<p class="noindent">#{lines.join}</p>)
+        puts %Q(<p class="noindent">#{join_lines_to_paragraph(lines)}</p>)
         puts "\n"
         @noindent = nil
       else
-        puts lines.join
+        puts join_lines_to_paragraph(lines)
         puts "\n"
       end
     end
@@ -63,24 +65,26 @@ module ReVIEW
       @noindent = true
     end
 
-    def list_header(id, caption, lang)
+    def list_header(id, caption, _lang)
       if get_chap.nil?
         print %Q(リスト#{@chapter.list(id).number} #{compile_inline(caption)}\n\n)
       else
         print %Q(リスト#{get_chap}.#{@chapter.list(id).number} #{compile_inline(caption)}\n\n)
       end
-      lang ||= ''
-      puts "```#{lang}"
     end
 
-    def list_body(_id, lines, _lang)
+    def list_body(_id, lines, lang)
+      lang ||= ''
+      puts "```#{lang}"
       lines.each do |line|
         puts detab(line)
       end
       puts '```'
     end
 
-    def listnum_body(lines, _lang)
+    def listnum_body(lines, lang)
+      lang ||= ''
+      puts "```#{lang}"
       lines.each_with_index do |line, i|
         puts((i + 1).to_s.rjust(2) + ": #{detab(line)}")
       end
@@ -93,7 +97,7 @@ module ReVIEW
     end
 
     def ul_item_begin(lines)
-      puts '  ' * (@ul_indent - 1) + '* ' + lines.join
+      puts '  ' * (@ul_indent - 1) + '* ' + join_lines_to_paragraph(lines)
     end
 
     def ul_item_end
@@ -109,7 +113,7 @@ module ReVIEW
     end
 
     def ol_item(lines, num)
-      puts "#{num}. #{lines.join}"
+      puts "#{num}. #{join_lines_to_paragraph(lines)}"
     end
 
     def ol_end
@@ -125,7 +129,7 @@ module ReVIEW
     end
 
     def dd(lines)
-      puts "<dd>#{lines.join}</dd>"
+      puts "<dd>#{join_lines_to_paragraph(lines)}</dd>"
     end
 
     def dl_end
@@ -134,9 +138,9 @@ module ReVIEW
 
     def emlist(lines, caption = nil, lang = nil)
       blank
-      if caption
+      if caption.present?
         puts caption
-        print "\n"
+        blank
       end
       lang ||= ''
       puts "```#{lang}"
@@ -236,7 +240,11 @@ module ReVIEW
       'jpg'
     end
 
-    def cmd(lines)
+    def cmd(lines, caption = nil)
+      if caption.present?
+        puts caption
+        blank
+      end
       puts '```shell-session'
       lines.each do |line|
         puts detab(line)
@@ -244,32 +252,12 @@ module ReVIEW
       puts '```'
     end
 
-    def table(lines, id = nil, caption = nil)
-      rows = []
-      sepidx = nil
-      lines.each_with_index do |line, idx|
-        if /\A[\=\-]{12}/ =~ line
-          # just ignore
-          # error "too many table separator" if sepidx
-          sepidx ||= idx
-          next
-        end
-        rows.push(line.strip.split(/\t+/).map { |s| s.sub(/\A\./, '') })
-      end
-      rows = adjust_n_cols(rows)
-      error 'no rows in the table' if rows.empty?
-
-      begin
-        table_header id, caption unless caption.nil?
-      rescue KeyError
-        error "no such table: #{id}"
-      end
-      table_begin rows.first.size
+    def table_rows(sepidx, rows)
       if sepidx
         sepidx.times do
           tr(rows.shift.map { |s| th(s) })
         end
-        table_border rows.first.size
+        table_border(rows.first.size)
         rows.each do |cols|
           tr(cols.map { |s| td(s) })
         end
@@ -279,7 +267,6 @@ module ReVIEW
           tr([th(h)] + cs.map { |s| td(s) })
         end
       end
-      table_end
     end
 
     def table_header(id, caption)
@@ -355,7 +342,7 @@ module ReVIEW
       return unless @book.config['draft']
       lines ||= []
       unless comment.blank?
-        lines.unshift comment
+        lines.unshift(comment)
       end
       str = lines.join('<br />')
       puts %Q(<div class="red">#{escape(str)}</div>)
@@ -380,7 +367,7 @@ module ReVIEW
 
     def flushright(lines)
       puts %Q(<div class="flushright">)
-      puts lines.join
+      puts split_paragraph(lines).join("\n")
       puts %Q(</div>)
     end
   end

data/lib/review/md2inaobuilder.rb

@@ -7,13 +7,11 @@ require 'review/markdownbuilder'
 module ReVIEW
   class MD2INAOBuilder < MARKDOWNBuilder
     def paragraph(lines)
-      puts '　' + lines.join
+      puts '　' + join_lines_to_paragraph(lines)
       puts "\n"
     end
 
-    def list_header(id, caption, lang)
-      lang ||= ''
-      puts "```#{lang}"
+    def list_header(id, caption, _lang)
       print %Q(●リスト#{@chapter.list(id).number}::#{compile_inline(caption)}\n\n)
     end
 
@@ -35,7 +33,7 @@ module ReVIEW
     end
 
     def dd(lines)
-      puts "<dd>#{lines.join}</dd>"
+      puts "<dd>#{join_lines_to_paragraph(lines)}</dd>"
     end
 
     def dl_end

data/lib/review/pdfmaker.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2018 Kenshi Muto and Masayoshi Takahashi
+# Copyright (c) 2010-2019 Kenshi Muto and Masayoshi Takahashi
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -54,12 +54,12 @@ module ReVIEW
     end
 
     def error(msg)
-      @logger.error "#{File.basename($PROGRAM_NAME, '.*')}: #{msg}"
+      @logger.error msg
       exit 1
     end
 
     def warn(msg)
-      @logger.warn "#{File.basename($PROGRAM_NAME, '.*')}: #{msg}"
+      @logger.warn msg
     end
 
     def pdf_filepath
@@ -153,20 +153,20 @@ module ReVIEW
       end
 
       begin
-        generate_pdf(yamlfile)
+        generate_pdf
       rescue ApplicationError => e
         raise if @config['debug']
         error(e.message)
       end
     end
 
-    def make_input_files(book, yamlfile)
+    def make_input_files(book)
       input_files = Hash.new { |h, key| h[key] = '' }
       book.parts.each do |part|
         if part.name.present?
           @config['use_part'] = true
           if part.file?
-            output_chaps(part.name, yamlfile)
+            output_chaps(part.name)
             input_files['CHAPS'] << %Q(\\input{#{part.name}.tex}\n)
           else
             input_files['CHAPS'] << %Q(\\part{#{part.name}}\n)
@@ -175,7 +175,7 @@ module ReVIEW
 
         part.chapters.each do |chap|
           filename = File.basename(chap.path, '.*')
-          output_chaps(filename, yamlfile)
+          output_chaps(filename)
           input_files['PREDEF'] << "\\input{#{filename}.tex}\n" if chap.on_predef?
           input_files['CHAPS'] << "\\input{#{filename}.tex}\n" if chap.on_chaps?
           input_files['APPENDIX'] << "\\input{#{filename}.tex}\n" if chap.on_appendix?
@@ -189,7 +189,7 @@ module ReVIEW
     def build_pdf
       template = template_content
       Dir.chdir(@path) do
-        File.open("./#{@mastertex}.tex", 'wb') { |f| f.write(template) }
+        File.open("./#{@mastertex}.tex", 'wb') { |f| f.write template }
 
         call_hook('hook_beforetexcompile')
 
@@ -250,18 +250,18 @@ module ReVIEW
       end
     end
 
-    def generate_pdf(yamlfile)
+    def generate_pdf
       remove_old_file
       erb_config
       @path = build_path
       begin
         @compile_errors = nil
 
-        book = ReVIEW::Book.load(File.dirname(yamlfile))
+        book = ReVIEW::Book.load(@basedir)
         book.config = @config
         @converter = ReVIEW::Converter.new(book, ReVIEW::LATEXBuilder.new)
 
-        @input_files = make_input_files(book, yamlfile)
+        @input_files = make_input_files(book)
 
         check_compile_status(@config['ignore-errors'])
 
@@ -281,11 +281,11 @@ module ReVIEW
 
         FileUtils.cp(File.join(@path, "#{@mastertex}.pdf"), pdf_filepath)
       ensure
-        remove_entry_secure @path unless @config['debug']
+        remove_entry_secure(@path) unless @config['debug']
       end
     end
 
-    def output_chaps(filename, _yamlfile)
+    def output_chaps(filename)
       @logger.info "compiling #{filename}.tex"
       begin
         @converter.convert(filename + '.re', File.join(@path, filename + '.tex'))
@@ -454,7 +454,7 @@ module ReVIEW
     def erb_content(file)
       @texcompiler = File.basename(@config['texcommand'], '.*')
       erb = ReVIEW::Template.load(file, '-')
-      @logger.debug "erb processes #{File.basename(file)}" if @config['debug']
+      @logger.debug("erb processes #{File.basename(file)}") if @config['debug']
       erb.result(binding)
     end
 
@@ -489,7 +489,7 @@ module ReVIEW
               f.print erb_content(File.join(dirname, fname))
             end
           else
-            FileUtils.cp File.join(dirname, fname), copybase
+            FileUtils.cp(File.join(dirname, fname), copybase)
           end
         end
       end

data/lib/review/plaintextbuilder.rb

@@ -87,7 +87,7 @@ module ReVIEW
     end
 
     def ul_item(lines)
-      puts lines.join
+      puts join_lines_to_paragraph(lines)
     end
 
     def ul_end
@@ -100,7 +100,7 @@ module ReVIEW
     end
 
     def ol_item(lines, num)
-      puts "#{num}　#{lines.join}"
+      puts "#{num}　#{join_lines_to_paragraph(lines)}"
     end
 
     def ol_end
@@ -127,7 +127,7 @@ module ReVIEW
     end
 
     def paragraph(lines)
-      puts lines.join
+      puts join_lines_to_paragraph(lines)
     end
 
     def read(lines)
@@ -137,21 +137,30 @@ module ReVIEW
 
     alias_method :lead, :read
 
-    def list_header(id, caption, _lang)
+    def list(lines, id, caption, lang = nil)
+      blank
+      begin
+        list_header(id, caption, lang)
+      rescue KeyError
+        error "no such list: #{id}"
+      end
+      blank
+      list_body(id, lines, lang)
       blank
+    end
+
+    def list_header(id, caption, _lang)
       if get_chap
         puts %Q(#{I18n.t('list')}#{I18n.t('format_number', [get_chap, @chapter.list(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)})
       else
         puts %Q(#{I18n.t('list')}#{I18n.t('format_number_without_chapter', [@chapter.list(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)})
       end
-      blank
     end
 
     def list_body(_id, lines, _lang)
       lines.each do |line|
         puts detab(line)
       end
-      blank
     end
 
     def base_block(_type, lines, caption = nil)
@@ -169,7 +178,7 @@ module ReVIEW
     end
 
     def emlist(lines, caption = nil, _lang = nil)
-      base_block 'emlist', lines, caption
+      base_block('emlist', lines, caption)
     end
 
     def emlistnum(lines, caption = nil, _lang = nil)
@@ -181,19 +190,30 @@ module ReVIEW
       blank
     end
 
+    def listnum(lines, id, caption, lang = nil)
+      blank
+      begin
+        list_header(id, caption, lang)
+      rescue KeyError
+        error "no such list: #{id}"
+      end
+      blank
+      listnum_body(lines, lang)
+      blank
+    end
+
     def listnum_body(lines, _lang)
       lines.each_with_index do |line, i|
         puts((i + 1).to_s.rjust(2) + ": #{line}")
       end
-      blank
     end
 
     def cmd(lines, caption = nil)
-      base_block 'cmd', lines, caption
+      base_block('cmd', lines, caption)
     end
 
     def quote(lines)
-      base_parablock 'quote', lines, nil
+      base_parablock('quote', lines, nil)
     end
 
     def image(_lines, id, caption, _metric = nil)
@@ -207,56 +227,27 @@ module ReVIEW
     end
 
     def texequation(lines, id = nil, caption = '')
+      blank
+      texequation_header(id, caption)
+      puts lines.join("\n")
+      blank
+    end
+
+    def texequation_header(id, caption)
       if id
-        blank
         if get_chap
           puts "#{I18n.t('equation')}#{I18n.t('format_number', [get_chap, @chapter.equation(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}"
         else
           puts "#{I18n.t('equation')}#{I18n.t('format_number_without_chapter', [@chapter.equation(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}"
         end
       end
-
-      puts lines.join("\n")
-      blank
     end
 
-    def table(lines, id = nil, caption = nil)
-      rows = []
-      sepidx = nil
-      lines.each_with_index do |line, idx|
-        if /\A[\=\-]{12}/ =~ line
-          # just ignore
-          # error "too many table separator" if sepidx
-          sepidx ||= idx
-          next
-        end
-        rows.push(line.strip.split(/\t+/).map { |s| s.sub(/\A\./, '') })
-      end
-      rows = adjust_n_cols(rows)
-      error 'no rows in the table' if rows.empty?
-
-      blank
-
-      begin
-        table_header(id, caption) if caption.present?
-      rescue KeyError
-        error "no such table: #{id}"
-      end
-      table_begin rows.first.size
-      if sepidx
-        sepidx.times do
-          tr(rows.shift.map { |s| th(s) })
-        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
+    def table(lines, id = nil, caption = nil, noblank = nil)
+      unless noblank
+        blank
       end
-      table_end
+      super(lines, id, caption)
     end
 
     def table_header(id, caption)
@@ -345,8 +336,8 @@ module ReVIEW
     end
 
     def bibpaper(lines, id, caption)
-      bibpaper_header id, caption
-      bibpaper_bibpaper id, caption, lines unless lines.empty?
+      bibpaper_header(id, caption)
+      bibpaper_bibpaper(id, caption, lines) unless lines.empty?
     end
 
     def bibpaper_header(id, caption)
@@ -355,7 +346,7 @@ module ReVIEW
     end
 
     def bibpaper_bibpaper(_id, _caption, lines)
-      print split_paragraph(lines).join
+      puts split_paragraph(lines).join("\n")
     end
 
     def inline_bib(id)
@@ -472,87 +463,87 @@ module ReVIEW
     end
 
     def flushright(lines)
-      base_parablock 'flushright', lines, nil
+      base_parablock('flushright', lines, nil)
     end
 
     def centering(lines)
-      base_parablock 'centering', lines, nil
+      base_parablock('centering', lines, nil)
     end
 
     def note(lines, caption = nil)
-      base_parablock 'note', lines, caption
+      base_parablock('note', lines, caption)
     end
 
     def memo(lines, caption = nil)
-      base_parablock 'memo', lines, caption
+      base_parablock('memo', lines, caption)
     end
 
     def tip(lines, caption = nil)
-      base_parablock 'tip', lines, caption
+      base_parablock('tip', lines, caption)
     end
 
     def info(lines, caption = nil)
-      base_parablock 'info', lines, caption
+      base_parablock('info', lines, caption)
     end
 
     def planning(lines, caption = nil)
-      base_parablock 'planning', lines, caption
+      base_parablock('planning', lines, caption)
     end
 
     def best(lines, caption = nil)
-      base_parablock 'best', lines, caption
+      base_parablock('best', lines, caption)
     end
 
     def important(lines, caption = nil)
-      base_parablock 'important', lines, caption
+      base_parablock('important', lines, caption)
     end
 
     def security(lines, caption = nil)
-      base_parablock 'security', lines, caption
+      base_parablock('security', lines, caption)
     end
 
     def caution(lines, caption = nil)
-      base_parablock 'caution', lines, caption
+      base_parablock('caution', lines, caption)
     end
 
     def term(lines)
-      base_parablock 'term', lines, nil
+      base_parablock('term', lines, nil)
     end
 
     def link(lines, caption = nil)
-      base_parablock 'link', lines, caption
+      base_parablock('link', lines, caption)
     end
 
     def notice(lines, caption = nil)
-      base_parablock 'notice', lines, caption
+      base_parablock('notice', lines, caption)
     end
 
     def point(lines, caption = nil)
-      base_parablock 'point', lines, caption
+      base_parablock('point', lines, caption)
     end
 
     def shoot(lines, caption = nil)
-      base_parablock 'shoot', lines, caption
+      base_parablock('shoot', lines, caption)
     end
 
     def reference(lines)
-      base_parablock 'reference', lines, nil
+      base_parablock('reference', lines, nil)
     end
 
     def practice(lines)
-      base_parablock 'practice', lines, nil
+      base_parablock('practice', lines, nil)
     end
 
     def expert(lines)
-      base_parablock 'expert', lines, nil
+      base_parablock('expert', lines, nil)
     end
 
     def insn(lines, caption = nil)
-      base_block 'insn', lines, caption
+      base_block('insn', lines, caption)
     end
 
     def warning(lines, caption = nil)
-      base_parablock 'warning', lines, caption
+      base_parablock('warning', lines, caption)
     end
 
     alias_method :box, :insn
@@ -573,7 +564,7 @@ module ReVIEW
     end
 
     def bpo(lines)
-      base_block 'bpo', lines, nil
+      base_block('bpo', lines, nil)
     end
 
     def inline_dtp(_str)
@@ -623,7 +614,7 @@ module ReVIEW
     end
 
     def source(lines, caption = nil, _lang = nil)
-      base_block 'source', lines, caption
+      base_block('source', lines, caption)
     end
 
     def inline_labelref(_idref)