review 4.0.0 → 5.1.1

data/lib/review/topbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2019 Minero Aoki, Kenshi Muto
+# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto
 #               2002-2006 Minero Aoki
 #
 # This program is free software.
@@ -78,7 +78,7 @@ module ReVIEW
 
     def dd(lines)
       split_paragraph(lines).each do |paragraph|
-        puts "\t#{paragraph.gsub(/\n/, '')}"
+        puts "\t#{paragraph.delete("\n")}"
       end
     end
 
@@ -95,12 +95,18 @@ module ReVIEW
       blank
       puts "◆→開始:#{@titles['list']}←◆"
       begin
-        list_header(id, caption, lang)
+        if caption_top?('list')
+          list_header(id, caption, lang)
+          blank
+        end
+        list_body(id, lines, lang)
+        unless caption_top?('list')
+          blank
+          list_header(id, caption, lang)
+        end
       rescue KeyError
         error "no such list: #{id}"
       end
-      blank
-      list_body(id, lines, lang)
       puts "◆→終了:#{@titles['list']}←◆"
       blank
     end
@@ -122,8 +128,13 @@ module ReVIEW
     def base_block(type, lines, caption = nil)
       blank
       puts "◆→開始:#{@titles[type]}←◆"
-      puts "■#{compile_inline(caption)}" if caption.present?
+      if caption_top?('list') && caption.present?
+        puts "■#{compile_inline(caption)}"
+      end
       puts lines.join("\n")
+      if !caption_top?('list') && caption.present?
+        puts "■#{compile_inline(caption)}"
+      end
       puts "◆→終了:#{@titles[type]}←◆"
       blank
     end
@@ -140,10 +151,15 @@ module ReVIEW
     def emlistnum(lines, caption = nil, _lang = nil)
       blank
       puts "◆→開始:#{@titles['emlist']}←◆"
-      puts "■#{compile_inline(caption)}" if caption.present?
+      if caption_top?('list') && caption.present?
+        puts "■#{compile_inline(caption)}"
+      end
       lines.each_with_index do |line, i|
         puts((i + 1).to_s.rjust(2) + ": #{line}")
       end
+      if !caption_top?('list') && caption.present?
+        puts "■#{compile_inline(caption)}"
+      end
       puts "◆→終了:#{@titles['emlist']}←◆"
       blank
     end
@@ -152,12 +168,18 @@ module ReVIEW
       blank
       puts "◆→開始:#{@titles['list']}←◆"
       begin
-        list_header(id, caption, lang)
+        if caption_top?('list') && caption.present?
+          list_header(id, caption, lang)
+          blank
+        end
+        listnum_body(lines, lang)
+        if !caption_top?('list') && caption.present?
+          blank
+          list_header(id, caption, lang)
+        end
       rescue KeyError
         error "no such list: #{id}"
       end
-      blank
-      listnum_body(lines, lang)
       puts "◆→終了:#{@titles['list']}←◆"
       blank
     end
@@ -173,8 +195,10 @@ module ReVIEW
       metrics = " #{metrics}" if metrics.present?
       blank
       puts "◆→開始:#{@titles['image']}←◆"
-      image_header(id, caption)
-      blank
+      if caption_top?('image')
+        image_header(id, caption)
+        blank
+      end
       if @chapter.image_bound?(id)
         puts "◆→#{@chapter.image(id).path}#{metrics}←◆"
       else
@@ -183,6 +207,10 @@ module ReVIEW
           puts line
         end
       end
+      unless caption_top?('image')
+        blank
+        image_header(id, caption)
+      end
       puts "◆→終了:#{@titles['image']}←◆"
       blank
     end
@@ -198,22 +226,20 @@ module ReVIEW
     def texequation(lines, id = nil, caption = '')
       blank
       puts "◆→開始:#{@titles['texequation']}←◆"
-      texequation_header(id, caption)
+      texequation_header(id, caption) if caption_top?('equation')
 
-      if @book.config['imgmath']
+      if @book.config['math_format'] == 'imgmath'
         fontsize = @book.config['imgmath_options']['fontsize'].to_f
         lineheight = @book.config['imgmath_options']['lineheight'].to_f
         math_str = "\\begin{equation*}\n\\fontsize{#{fontsize}}{#{lineheight}}\\selectfont\n#{lines.join("\n")}\n\\end{equation*}\n"
         key = Digest::SHA256.hexdigest(math_str)
-        math_dir = File.join(@book.config['imagedir'], '_review_math_text')
-        Dir.mkdir(math_dir) unless Dir.exist?(math_dir)
-        img_path = File.join(math_dir, "_gen_#{key}.#{@book.config['imgmath_options']['format']}")
-        defer_math_image(math_str, img_path, key)
+        img_path = @img_math.defer_math_image(math_str, key)
         puts "◆→math:#{File.basename(img_path)}←◆"
       else
         puts lines.join("\n")
       end
 
+      texequation_header(id, caption) unless caption_top?('equation')
       puts "◆→終了:#{@titles['texequation']}←◆"
       blank
     end
@@ -245,6 +271,7 @@ module ReVIEW
 
     def comment(lines, comment = nil)
       return unless @book.config['draft']
+
       lines ||= []
       unless comment.blank?
         lines.unshift(comment)
@@ -338,6 +365,18 @@ module ReVIEW
       "＠#{str}＠◆→＠〜＠部分に下線←◆"
     end
 
+    def inline_ins(str)
+      "◆→開始:挿入表現←◆#{str}◆→終了:挿入表現←◆"
+    end
+
+    def inline_del(str)
+      "◆→開始:削除表現←◆#{str}◆→終了:削除表現←◆"
+    end
+
+    def inline_tcy(str)
+      "◆→開始:回転←◆#{str}◆→終了:縦回転←◆"
+    end
+
     def inline_icon(id)
       begin
         "◆→画像 #{@chapter.image(id).path.sub(%r{\A\./}, '')}←◆"
@@ -368,13 +407,10 @@ module ReVIEW
     end
 
     def inline_m(str)
-      if @book.config['imgmath']
+      if @book.config['math_format'] == 'imgmath'
         math_str = '$' + str + '$'
         key = Digest::SHA256.hexdigest(str)
-        math_dir = File.join(@book.config['imagedir'], '_review_math_text')
-        Dir.mkdir(math_dir) unless Dir.exist?(math_dir)
-        img_path = File.join(math_dir, "_gen_#{key}.#{@book.config['imgmath_options']['format']}")
-        defer_math_image(math_str, img_path, key)
+        img_path = @img_math.defer_math_image(math_str, key)
         %Q(◆→TeX式ここから←◆◆→math:#{File.basename(img_path)}←◆◆→TeX式ここまで←◆)
       else
         %Q(◆→TeX式ここから←◆#{str}◆→TeX式ここまで←◆)
@@ -415,17 +451,48 @@ module ReVIEW
       blank
     end
 
+    def common_block_begin(type, _level, _label, caption = nil)
+      blank
+      puts "◆→開始:#{@titles[type]}←◆"
+      puts '■' + compile_inline(caption) if caption.present?
+    end
+
+    def common_block_end(type, _level)
+      puts "◆→終了:#{@titles[type]}←◆"
+      blank
+    end
+
+    CAPTION_TITLES.each do |name|
+      class_eval %Q(
+        def #{name}_begin(caption = nil)
+          check_nested_minicolumn
+          @doc_status[:minicolumn] = '#{name}'
+          common_block_begin('#{name}', nil, nil, caption)
+        end
+
+        def #{name}_end
+          common_block_end('#{name}', nil)
+          @doc_status[:minicolumn] = nil
+        end
+      ), __FILE__, __LINE__ - 11
+    end
+
     def indepimage(_lines, id, caption = nil, metric = nil)
       metrics = parse_metric('top', metric)
       metrics = " #{metrics}" if metrics.present?
       blank
+      if caption_top?('image') && caption.present?
+        puts "図　#{compile_inline(caption)}"
+      end
       begin
         puts "◆→画像 #{@chapter.image(id).path.sub(%r{\A\./}, '')}#{metrics}←◆"
       rescue
         warn "image not bound: #{id}"
         puts "◆→画像 #{id}←◆"
       end
-      puts "図　#{compile_inline(caption)}" if caption.present?
+      if !caption_top?('image') && caption.present?
+        puts "図　#{compile_inline(caption)}"
+      end
       blank
     end
 

data/lib/review/update.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2018-2019 Kenshi Muto
+# Copyright (c) 2018-2020 Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -20,7 +20,7 @@ module ReVIEW
     end
 
     # should be
-    TARGET_VERSION = '4.0'
+    TARGET_VERSION = '5.0'
     EPUB_VERSION = '3'
     HTML_VERSION = '5'
     TEX_DOCUMENTCLASS = ['review-jsbook', 'review-jlreq']
@@ -239,7 +239,7 @@ module ReVIEW
     def update_version
       @config_ymls.each do |yml|
         config = YAML.load_file(yml)
-        if config['review_version'].to_f == TARGET_VERSION.to_f
+        if config['review_version'].to_f.round(1) == TARGET_VERSION.to_f.round(1)
           next
         end
 
@@ -301,6 +301,7 @@ module ReVIEW
         if !config['htmlversion'].present? || config['htmlversion'].to_f >= HTML_VERSION.to_f
           next
         end
+
         if confirm("%s: Update '%s' to '%s' from '%s'?", [File.basename(yml), 'htmlversion', HTML_VERSION, config['htmlversion']])
           rewrite_yml(yml, 'htmlversion', HTML_VERSION)
         end
@@ -313,6 +314,7 @@ module ReVIEW
         if !config['chapter_quote'].present? || config['chapter_quote'].scan('%s').size != 1
           next
         end
+
         v = config['chapter_quote'].sub('%s', '%s %s')
         if confirm("%s: 'chapter_quote' now takes 2 values. Update '%s' to '%s'?", [File.basename(yml), config['chapter_quote'], v])
           rewrite_yml(yml, 'chapter_quote', v)
@@ -414,9 +416,7 @@ module ReVIEW
             opts << "paper=#{v.sub('j', '').sub('paper', '')}"
           when /[\d.]+ptj/ # not cared...
             opts << "fontsize=#{v.sub('j', '')}"
-          when /[\d.]+pt/
-            opts << "fontsize=#{v}"
-          when /[\d.]+Q/
+          when /[\d.]+pt/, /[\d.]+Q/
             opts << "fontsize=#{v}"
           when 'landscape', 'oneside', 'twoside', 'vartwoside', 'onecolumn',
                'twocolumn', 'titlepage', 'notitlepage', 'openright',
@@ -442,9 +442,7 @@ module ReVIEW
             opts << "paper=#{v.sub('j', '').sub('paper', '')}"
           when /[\d.]+ptj/ # not cared...
             opts << "fontsize=#{v.sub('j', '')}"
-          when /[\d.]+pt/
-            opts << "fontsize=#{v}"
-          when /[\d.]+Q/
+          when /[\d.]+pt/, /[\d.]+Q/
             opts << "fontsize=#{v}"
           when 'landscape', 'oneside', 'twoside', 'onecolumn', 'twocolumn', 'titlepage', 'notitlepage', 'openright', 'openany', 'leqno', 'fleqn', 'draft', 'final', 'report'
             # pass-through
@@ -513,11 +511,12 @@ module ReVIEW
     def update_tex_command
       @tex_ymls.each do |yml|
         config = YAML.load_file(yml)
-        if !config['texcommand'] || config['texcommand'] !~ /\s+\-/
+        if !config['texcommand'] || config['texcommand'] !~ /\s+-/
           next
         end
+
         # option should be moved to texoptions
-        cmd, opts = config['texcommand'].split(/\s+\-/, 2)
+        cmd, opts = config['texcommand'].split(/\s+-/, 2)
         opts = "-#{opts}"
 
         unless confirm("%s: 'texcommand' has options ('%s'). Move it to 'texoptions'?", [File.basename(yml), opts])
@@ -537,12 +536,12 @@ module ReVIEW
     def update_dvi_command
       @tex_ymls.each do |yml|
         config = YAML.load_file(yml)
-        if !config['dvicommand'] || config['dvicommand'] !~ /\s+\-/
+        if !config['dvicommand'] || config['dvicommand'] !~ /\s+-/
           next
         end
 
         # option should be moved to dvioptions
-        cmd, opts = config['dvicommand'].split(/\s+\-/, 2)
+        cmd, opts = config['dvicommand'].split(/\s+-/, 2)
         opts = "-#{opts}"
 
         unless confirm("%s: 'dvicommand' has options ('%s'). Move it to 'dvioptions'?", [File.basename(yml), opts])

data/lib/review/version.rb

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

data/lib/review/volumeprinter.rb

@@ -0,0 +1,97 @@
+#
+# Copyright (c) 2014-2021 Minero Aoki, Kenshi Muto
+#               2003-2014 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.
+# For details of the GNU LGPL, see the file "COPYING".
+#
+require 'optparse'
+require 'review'
+require 'review/i18n'
+require 'review/plaintextbuilder'
+
+include ReVIEW::TextUtils
+
+module ReVIEW
+  class VolumePrinter
+    def self.execute(*args)
+      new.execute(*args)
+    end
+
+    def initialize
+      @logger = ReVIEW.logger
+      @yamlfile = 'config.yml'
+    end
+
+    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
+        @book.each_part do |part|
+          if part.number
+            print_chapter_volume(part)
+          end
+          part.each_chapter do |chap|
+            print_chapter_volume(chap)
+          end
+        end
+      rescue ReVIEW::FileNotFound, ReVIEW::CompileError, ReVIEW::ApplicationError => e
+        @logger.error e.message
+        exit 1
+      end
+      puts '============================='
+      print_volume(@book.volume)
+    end
+
+    def parse_options(args)
+      opts = OptionParser.new
+      opts.version = ReVIEW::VERSION
+      opts.on('--yaml=YAML', 'Read configurations from YAML file.') { |yaml| @yamlfile = yaml }
+      opts.on('--help', 'Print this message and quit') do
+        puts opts.help
+        exit 0
+      end
+      begin
+        opts.parse!(args)
+      rescue OptionParser::ParseError => e
+        @logger.error e.message
+        $stderr.puts opts.help
+        exit 1
+      end
+    end
+
+    def print_chapter_volume(chap)
+      builder = ReVIEW::PLAINTEXTBuilder.new
+      builder.bind(ReVIEW::Compiler.new(builder), chap, nil)
+
+      vol = chap.volume
+      title = chap.format_number
+      unless title.empty?
+        title += '  '
+      end
+      begin
+        title += builder.compile_inline(chap.title)
+      rescue ReVIEW::ApplicationError => e
+        @logger.warn "#{chap.name} : #{e.message.sub(/.+error: /, '')}"
+      end
+
+      printf("%3dKB %6dC %5dL %3dP  %s %-s\n",
+             vol.kbytes, vol.chars, vol.lines, vol.page,
+             "#{chap.name} ".ljust(15, '.'), title)
+    end
+
+    def print_volume(vol)
+      # total
+      printf("%3dKB %6dC %5dL %3dP\n", vol.kbytes, vol.chars, vol.lines, vol.page)
+    end
+  end
+end

data/lib/review/webmaker.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2016-2018 Masayoshi Takahashi, Masanori Kado, Kenshi Muto
+# Copyright (c) 2016-2021 Masayoshi Takahashi, Masanori Kado, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -19,8 +19,8 @@ require 'review/yamlloader'
 require 'review/template'
 require 'review/tocprinter'
 require 'review/version'
-require 'erb'
 require 'review/makerhelper'
+require 'review/img_math'
 
 module ReVIEW
   class WEBMaker
@@ -32,6 +32,7 @@ module ReVIEW
     def initialize
       @basedir = nil
       @logger = ReVIEW.logger
+      @img_math = nil
     end
 
     def error(msg)
@@ -50,6 +51,7 @@ module ReVIEW
     def parse_opts(args)
       cmd_config = {}
       opts = OptionParser.new
+      @buildonly = nil
 
       opts.banner = 'Usage: review-webmaker [option] configfile'
       opts.version = ReVIEW::VERSION
@@ -58,6 +60,7 @@ module ReVIEW
         exit 0
       end
       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
@@ -73,30 +76,28 @@ module ReVIEW
     end
 
     def remove_old_files(path)
-      cleanup_mathimg
+      @img_math.cleanup_mathimg
       FileUtils.rm_rf(path)
     end
 
     def execute(*args)
-      @config = ReVIEW::Configure.values
-      @config.maker = 'webmaker'
       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
-      # YAML configs will be overridden by command line options.
-      @config.deep_merge!(cmd_config)
+      @config = ReVIEW::Configure.create(maker: 'webmaker',
+                                         yamlfile: yamlfile,
+                                         config: cmd_config)
+
       @config['htmlext'] = 'html'
+      @img_math = ReVIEW::ImgMath.new(@config)
+
       I18n.setup(@config['language'])
       begin
         generate_html_files(yamlfile)
+        @logger.success("built #{build_path}")
       rescue ApplicationError => e
         raise if @config['debug']
+
         error(e.message)
       end
     end
@@ -107,17 +108,16 @@ module ReVIEW
       remove_old_files(@path)
       Dir.mkdir(@path)
 
-      @book = ReVIEW::Book.load(@basedir)
-      @book.config = @config
+      @book = ReVIEW::Book::Base.new(@basedir, config: @config)
+      @converter = ReVIEW::Converter.new(@book, ReVIEW::HTMLBuilder.new(img_math: @img_math))
 
       copy_stylesheet(@path)
       copy_frontmatter(@path)
       build_body(@path, yamlfile)
       copy_backmatter(@path)
 
-      math_dir = "./#{@config['imagedir']}/_review_math"
-      if @config['imgmath'] && File.exist?("#{math_dir}/__IMGMATH_BODY__.tex")
-        make_math_images(math_dir)
+      if @config['math_format'] == 'imgmath'
+        @img_math.make_math_images
       end
 
       copy_images(@config['imagedir'], "#{@path}/#{@config['imagedir']}")
@@ -127,16 +127,8 @@ module ReVIEW
       copy_resources(@config['fontdir'], "#{@path}/fonts", @config['font_ext'])
     end
 
-    def clean_mathdir
-      if @config['imgmath'] && File.exist?("#{@config['imagedir']}/_review_math")
-        FileUtils.rm_rf("#{@config['imagedir']}/_review_math")
-      end
-    end
-
     def build_body(basetmpdir, _yamlfile)
       base_path = Pathname.new(@basedir)
-      builder = ReVIEW::HTMLBuilder.new
-      @converter = ReVIEW::Converter.new(@book, builder)
       @book.parts.each do |part|
         if part.name.present?
           if part.file?
@@ -154,6 +146,7 @@ module ReVIEW
     end
 
     def build_part(part, basetmpdir, htmlfile)
+      @title = h("#{ReVIEW::I18n.t('part', part.number)} #{part.name.strip}")
       File.open("#{basetmpdir}/#{htmlfile}", 'w') do |f|
         @body = ''
         @body << %Q(<div class="part">\n)
@@ -163,8 +156,7 @@ module ReVIEW
 
         @language = @config['language']
         @stylesheets = @config['stylesheet']
-        tmplfile = File.expand_path(template_name, ReVIEW::Template::TEMPLATE_DIR)
-        f.write ReVIEW::Template.load(tmplfile).result(binding)
+        f.write ReVIEW::Template.generate(path: template_name, binding: binding)
       end
     end
 
@@ -186,6 +178,11 @@ module ReVIEW
       end
       id = File.basename(filename).sub(/\.re\Z/, '')
 
+      if @buildonly && !@buildonly.include?(id)
+        warn "skip #{id}.re"
+        return
+      end
+
       htmlfile = "#{id}.#{@config['htmlext']}"
 
       if @config['params'].present?
@@ -202,6 +199,7 @@ module ReVIEW
 
     def copy_images(resdir, destdir)
       return nil unless File.exist?(resdir)
+
       allow_exts = @config['image_ext']
       FileUtils.mkdir_p(destdir)
       recursive_copy_files(resdir, destdir, allow_exts)
@@ -209,6 +207,7 @@ module ReVIEW
 
     def copy_resources(resdir, destdir, allow_exts = nil)
       return nil if !resdir || !File.exist?(resdir)
+
       allow_exts ||= @config['image_ext']
       FileUtils.mkdir_p(destdir)
       recursive_copy_files(resdir, destdir, allow_exts)
@@ -218,6 +217,7 @@ module ReVIEW
       Dir.open(resdir) do |dir|
         dir.each do |fname|
           next if fname.start_with?('.')
+
           if FileTest.directory?("#{resdir}/#{fname}")
             recursive_copy_files("#{resdir}/#{fname}", "#{destdir}/#{fname}", allow_exts)
           elsif fname =~ /\.(#{allow_exts.join('|')})\Z/i
@@ -252,6 +252,7 @@ module ReVIEW
     end
 
     def build_indexpage(basetmpdir)
+      @title = h('index')
       File.open("#{basetmpdir}/index.html", 'w') do |f|
         if @config['coverimage']
           file = File.join(@config['imagedir'], @config['coverimage'])
@@ -268,16 +269,16 @@ module ReVIEW
         @toc = ReVIEW::WEBTOCPrinter.book_to_string(@book)
         @next = @book.chapters[0]
         @next_title = @next ? @next.title : ''
-        tmplfile = File.expand_path(template_name, ReVIEW::Template::TEMPLATE_DIR)
-        f.write ReVIEW::Template.load(tmplfile).result(binding)
+        f.write ReVIEW::Template.generate(path: template_name, binding: binding)
       end
     end
 
     def build_titlepage(basetmpdir, htmlfile)
+      @title = h('titlepage')
       File.open("#{basetmpdir}/#{htmlfile}", 'w') do |f|
         @body = ''
         @body << %Q(<div class="titlepage">)
-        @body << %Q(<h1 class="tp-title">#{CGI.escapeHTML(@config.name_of('booktitle'))}</h1>)
+        @body << %Q(<h1 class="tp-title">#{h(@config.name_of('booktitle'))}</h1>)
         if @config['aut']
           @body << %Q(<h2 class="tp-author">#{join_with_separator(@config.names_of('aut'), ReVIEW::I18n.t('names_splitter'))}</h2>)
         end
@@ -288,8 +289,7 @@ module ReVIEW
 
         @language = @config['language']
         @stylesheets = @config['stylesheet']
-        tmplfile = File.expand_path(template_name, ReVIEW::Template::TEMPLATE_DIR)
-        f.write ReVIEW::Template.load(tmplfile).result(binding)
+        f.write ReVIEW::Template.generate(path: template_name, binding: binding)
       end
     end
 
@@ -304,6 +304,7 @@ module ReVIEW
 
     def copy_file_with_param(name, target_file = nil)
       return if @config[name].nil? || !File.exist?(@config[name])
+
       target_file ||= File.basename(@config[name])
       FileUtils.cp(@config[name], File.join(@path, target_file))
     end