review 3.1.0 → 5.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/location.rb

@@ -0,0 +1,32 @@
+# Copyright (c) 2009-2019 Minero Aoki, Kenshi Muto, Masayoshi Takahashi
+# Copyright (c) 2002-2007 Minero Aoki
+#
+# 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.
+#
+
+module ReVIEW
+  class Location
+    def initialize(filename, f)
+      @filename = filename
+      @f = f
+    end
+
+    attr_reader :filename
+
+    def lineno
+      @f.lineno
+    end
+
+    def string
+      begin
+        "#{@filename}:#{@f.lineno}"
+      rescue
+        "#{@filename}:nil"
+      end
+    end
+
+    alias_method :to_s, :string
+  end
+end

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

@@ -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
@@ -10,6 +10,12 @@ require 'fileutils'
 require 'yaml'
 require 'shellwords'
 
+begin
+  require 'cgi/escape'
+rescue
+  require 'cgi/util'
+end
+
 module ReVIEW
   module MakerHelper
     # Return review/bin directory
@@ -18,6 +24,11 @@ module ReVIEW
     end
     module_function :bindir
 
+    def h(str)
+      CGI.escapeHTML(str)
+    end
+    module_function :h
+
     # Copy image files under from_dir to to_dir recursively
     # ==== Args
     # from_dir :: path to the directory which has image files to be copied
@@ -55,7 +66,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 +77,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
@@ -112,6 +123,22 @@ module ReVIEW
 \\end{document}
 EOB
 
+      hashes = File.readlines(File.join(math_dir, '__IMGMATH_BODY__.map')).sort.uniq
+      File.write(File.join(math_dir, '__IMGMATH_BODY__.map'), hashes.join)
+
+      File.open(File.join(math_dir, '__IMGMATH_BODY__.tex'), 'w') do |f|
+        File.open(File.join(math_dir, '__IMGMATH_BODY__.map')) do |map|
+          map.each_line do |l|
+            l.chomp!
+            f.puts "% #{l}"
+            f.puts File.read(File.join(math_dir, "__IMGMATH_BODY__#{l}.tex"))
+            File.unlink(File.join(math_dir, "__IMGMATH_BODY__#{l}.tex"))
+            f.puts '\\clearpage'
+            f.puts
+          end
+        end
+      end
+
       math_dir = File.realpath(math_dir)
       Dir.mktmpdir do |tmpdir|
         FileUtils.cp([File.join(math_dir, '__IMGMATH_BODY__.tex'),
@@ -139,8 +166,10 @@ EOB
       FileUtils.rm_f([File.join(math_dir, '__IMGMATH_BODY__.tex'),
                       File.join(math_dir, '__IMGMATH_BODY__.map')])
     end
+    module_function :make_math_images
 
     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 +184,6 @@ EOB
             raise CompileError
           end
         end
-
         args = @config['imgmath_options']['pdfcrop_cmd'].shellsplit
         args.map! do |m|
           m.sub('%i', pdf_path).
@@ -201,6 +229,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 +242,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,30 +65,39 @@ 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)
+      lang ||= ''
+      puts "```#{lang}"
+      lines.each_with_index do |line, i|
+        puts((i + 1).to_s.rjust(2) + ": #{detab(line)}")
+      end
+      puts '```'
+    end
+
     def ul_begin
       blank if @ul_indent == 0
       @ul_indent += 1
     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
@@ -102,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
@@ -118,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
@@ -127,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}"
@@ -144,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
@@ -229,7 +258,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)
@@ -237,32 +270,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)
-
-      begin
-        table_header id, caption unless caption.nil?
-      rescue KeyError
-        error "no such table: #{id}"
-      end
-      table_begin rows.first.size
-      return if rows.empty?
+    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
@@ -272,7 +285,6 @@ module ReVIEW
           tr([th(h)] + cs.map { |s| td(s) })
         end
       end
-      table_end
     end
 
     def table_header(id, caption)
@@ -348,7 +360,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>)
@@ -373,7 +385,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-2020 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
@@ -100,6 +100,7 @@ module ReVIEW
     def parse_opts(args)
       cmd_config = {}
       opts = OptionParser.new
+      @buildonly = nil
 
       opts.banner = 'Usage: review-pdfmaker configfile'
       opts.version = ReVIEW::VERSION
@@ -109,6 +110,7 @@ module ReVIEW
       end
       opts.on('--[no-]debug', 'Keep temporary files.') { |debug| cmd_config['debug'] = debug }
       opts.on('--ignore-errors', 'Ignore review-compile errors.') { cmd_config['ignore-errors'] = true }
+      opts.on('-y', '--only file1,file2,...', 'Build only specified files.') { |v| @buildonly = v.split(/\s*,\s*/).map { |m| m.strip.sub(/\.re\Z/, '') } }
 
       opts.parse!(args)
       if args.size != 1
@@ -120,20 +122,13 @@ module ReVIEW
     end
 
     def execute(*args)
-      @config = ReVIEW::Configure.values
-      @config.maker = 'pdfmaker'
       cmd_config, yamlfile = parse_opts(args)
       error "#{yamlfile} not found." unless File.exist?(yamlfile)
 
-      begin
-        loader = ReVIEW::YAMLLoader.new
-        @config.deep_merge!(loader.load_file(yamlfile))
-      rescue => e
-        error "yaml error #{e.message}"
-      end
+      @config = ReVIEW::Configure.create(maker: 'pdfmaker',
+                                         yamlfile: yamlfile,
+                                         config: cmd_config)
 
-      # YAML configs will be overridden by command line options.
-      @config.deep_merge!(cmd_config)
       I18n.setup(@config['language'])
       @basedir = File.absolute_path(File.dirname(yamlfile))
 
@@ -153,21 +148,26 @@ 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)
-            input_files['CHAPS'] << %Q(\\input{#{part.name}.tex}\n)
+            if @buildonly && !@buildonly.include?(part.name)
+              warn "skip #{part.name}.re"
+              input_files['CHAPS'] << %Q(\\part{}\n)
+            else
+              output_chaps(part.name)
+              input_files['CHAPS'] << %Q(\\input{#{part.name}.tex}\n)
+            end
           else
             input_files['CHAPS'] << %Q(\\part{#{part.name}}\n)
           end
@@ -175,11 +175,18 @@ module ReVIEW
 
         part.chapters.each do |chap|
           filename = File.basename(chap.path, '.*')
-          output_chaps(filename, yamlfile)
-          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?
-          input_files['POSTDEF'] << "\\input{#{filename}.tex}\n" if chap.on_postdef?
+          entry = "\\input{#{filename}.tex}\n"
+          if @buildonly && !@buildonly.include?(filename)
+            warn "skip #{filename}.re"
+            entry = "\\chapter{}\n"
+          else
+            output_chaps(filename)
+          end
+
+          input_files['PREDEF'] << entry if chap.on_predef?
+          input_files['CHAPS'] << entry if chap.on_chaps?
+          input_files['APPENDIX'] << entry if chap.on_appendix?
+          input_files['POSTDEF'] << entry if chap.on_postdef?
         end
       end
 
@@ -189,7 +196,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')
 
@@ -235,8 +242,9 @@ module ReVIEW
         end
 
         call_hook('hook_beforemakeindex')
-        if @config['pdfmaker']['makeindex'] && File.exist?("#{@mastertex}.idx")
+        if @config['pdfmaker']['makeindex'] && File.size?("#{@mastertex}.idx")
           system_or_raise(*[makeindex_command, makeindex_options, @mastertex].flatten.compact)
+          system_or_raise(*[texcommand, texoptions, "#{@mastertex}.tex"].flatten.compact)
         end
         call_hook('hook_aftermakeindex')
 
@@ -250,18 +258,17 @@ 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.config = @config
+        book = ReVIEW::Book::Base.new(@basedir, 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 +288,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'))
@@ -296,23 +303,12 @@ module ReVIEW
       end
     end
 
-    # PDFMaker#copy_images should copy image files _AND_ execute extractbb (or ebb).
+    # PDFMaker#copy_images should copy image files
     #
     def copy_images(from, to)
       return unless File.exist?(from)
       Dir.mkdir(to)
       ReVIEW::MakerHelper.copy_images_to_dir(from, to)
-      Dir.chdir(to) do
-        images = Dir.glob('**/*').find_all { |f| File.file?(f) and f =~ /\.(jpg|jpeg|png|pdf|ai|eps|tif)\z/i }
-        break if images.empty?
-        if @config['pdfmaker']['bbox']
-          system_with_info('extractbb', '-B', @config['pdfmaker']['bbox'], *images)
-          system_or_raise('ebb', '-B', @config['pdfmaker']['bbox'], *images) unless system('extractbb', '-B', @config['pdfmaker']['bbox'], '-m', *images)
-        else
-          system_with_info('extractbb', *images)
-          system_or_raise('ebb', *images) unless system('extractbb', '-m', *images)
-        end
-      end
     end
 
     def make_custom_page(file)
@@ -370,11 +366,11 @@ module ReVIEW
           items.each_with_index do |item, rev|
             editstr = edit == 0 ? ReVIEW::I18n.t('first_edition') : ReVIEW::I18n.t('nth_edition', (edit + 1).to_s)
             revstr = ReVIEW::I18n.t('nth_impression', (rev + 1).to_s)
-            if item =~ /\A\d+\-\d+\-\d+\Z/
+            if item =~ /\A\d+-\d+-\d+\Z/
               buf << ReVIEW::I18n.t('published_by1', [date_to_s(item), editstr + revstr])
-            elsif item =~ /\A(\d+\-\d+\-\d+)[\s　](.+)/
+            elsif item =~ /\A(\d+-\d+-\d+)[\s　](.+)/
               # custom date with string
-              item.match(/\A(\d+\-\d+\-\d+)[\s　](.+)/) { |m| buf << ReVIEW::I18n.t('published_by3', [date_to_s(m[1]), m[2]]) }
+              item.match(/\A(\d+-\d+-\d+)[\s　](.+)/) { |m| buf << ReVIEW::I18n.t('published_by3', [date_to_s(m[1]), m[2]]) }
             else
               # free format
               buf << item
@@ -440,26 +436,33 @@ module ReVIEW
       end
 
       @locale_latex = {}
-      part_tuple = I18n.get('part').split(/\%[A-Za-z]{1,3}/, 2)
-      chapter_tuple = I18n.get('chapter').split(/\%[A-Za-z]{1,3}/, 2)
-      appendix_tuple = I18n.get('appendix').split(/\%[A-Za-z]{1,3}/, 2)
-      @locale_latex['prepartname'] = part_tuple[0]
-      @locale_latex['postpartname'] = part_tuple[1]
-      @locale_latex['prechaptername'] = chapter_tuple[0]
-      @locale_latex['postchaptername'] = chapter_tuple[1]
-      @locale_latex['preappendixname'] = appendix_tuple[0]
-      @locale_latex['postappendixname'] = appendix_tuple[1]
+      part_tuple = I18n.get('part').split(/%[A-Za-z]{1,3}/, 2)
+      chapter_tuple = I18n.get('chapter').split(/%[A-Za-z]{1,3}/, 2)
+      appendix_tuple = I18n.get('appendix').split(/%[A-Za-z]{1,3}/, 2)
+      @locale_latex['prepartname'] = part_tuple[0].to_s
+      @locale_latex['postpartname'] = part_tuple[1].to_s
+      @locale_latex['prechaptername'] = chapter_tuple[0].to_s
+      @locale_latex['postchaptername'] = chapter_tuple[1].to_s
+      @locale_latex['preappendixname'] = appendix_tuple[0].to_s
+      @locale_latex['postappendixname'] = appendix_tuple[1].to_s
     end
 
     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
 
     def latex_config
-      erb_content(File.expand_path('./latex/config.erb', ReVIEW::Template::TEMPLATE_DIR))
+      result = erb_content(File.expand_path('./latex/config.erb', ReVIEW::Template::TEMPLATE_DIR))
+      local_config_file = File.join(@basedir, 'layouts', 'config-local.tex.erb')
+      if File.exist?(local_config_file)
+        result << "%% BEGIN: config-local.tex.erb\n"
+        result << erb_content(local_config_file)
+        result << "%% END: config-local.tex.erb\n"
+      end
+      result
     end
 
     def template_content
@@ -489,7 +492,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