review 4.1.0 → 5.2.0

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.1.0'.freeze
+  VERSION = '5.2.0'.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-2020 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,28 +19,23 @@ require 'review/yamlloader'
 require 'review/template'
 require 'review/tocprinter'
 require 'review/version'
-require 'erb'
 require 'review/makerhelper'
+require 'review/img_math'
+require 'review/loggable'
 
 module ReVIEW
   class WEBMaker
     include ERB::Util
     include MakerHelper
+    include Loggable
 
     attr_accessor :config, :basedir
 
     def initialize
       @basedir = nil
       @logger = ReVIEW.logger
-    end
-
-    def error(msg)
-      @logger.error msg
-      exit 1
-    end
-
-    def warn(msg)
-      @logger.warn msg
+      @img_math = nil
+      @compile_errors = nil
     end
 
     def self.execute(*args)
@@ -75,31 +70,29 @@ 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)
+      error! "#{yamlfile} not found." unless File.exist?(yamlfile)
+
+      @config = ReVIEW::Configure.create(maker: 'webmaker',
+                                         yamlfile: yamlfile,
+                                         config: cmd_config)
 
-      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['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)
+
+        error! e.message
       end
     end
 
@@ -109,17 +102,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']}")
@@ -129,16 +121,9 @@ 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)
+      @compile_errors = nil
       @book.parts.each do |part|
         if part.name.present?
           if part.file?
@@ -153,9 +138,13 @@ module ReVIEW
 
         part.chapters.each { |chap| build_chap(chap, base_path, basetmpdir, false) }
       end
+      if @compile_errors
+        app_error 'compile error, No web files output.'
+      end
     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)
@@ -165,8 +154,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
 
@@ -201,14 +189,16 @@ module ReVIEW
 
       begin
         @converter.convert(filename, File.join(basetmpdir, htmlfile))
-      rescue => e
-        warn "compile error in #{filename} (#{e.class})"
-        warn e.message
+      rescue ApplicationError => e
+        @compile_errors = true
+        error "compile error in #{filename} (#{e.class})"
+        error e.message
       end
     end
 
     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)
@@ -216,6 +206,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)
@@ -225,6 +216,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
@@ -259,6 +251,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'])
@@ -275,16 +268,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
@@ -295,8 +288,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
 
@@ -311,6 +303,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

data/lib/review/webtocprinter.rb

@@ -1,54 +1,58 @@
 require 'review/tocprinter'
 require 'review/i18n'
+require 'review/htmlutils'
 
 module ReVIEW
   class WEBTOCPrinter < TOCPrinter
     include HTMLUtils
 
     def self.book_to_string(book)
-      io = StringIO.new
-      ReVIEW::WEBTOCPrinter.new(1, {}, io).print_book(book)
-      io.seek(0)
-      io.read
+      ReVIEW::WEBTOCPrinter.new.print_book(book)
     end
 
     def print_book(book)
-      @out.puts '<ul class="book-toc">'
-      @out.puts %Q(<li><a href="index.html">TOP</a></li>\n)
-      book.each_part do |part|
-        print_part(part)
-      end
-      @out.puts '</ul>'
+      @book = book
+      @indent = nil
+      @upper = 1 # only part and chapter
+      print_result(build_result_array)
     end
 
-    def print_part(part)
-      if part.number
-        if part.file?
-          ext = part.book.config['htmlext'] || 'html'
-          path = File.basename(part.path.sub(/\.re/, '.' + ext))
-          @out.puts %Q(<li><a href="#{path}">#{h(I18n.t('part_short', part.number) + ' ' + part.title)}</a>\n<ul>\n)
+    def print_result(result_array)
+      content = <<EOT
+<ul class="book-toc">
+<li><a href="index.html">TOP</a></li>
+EOT
+
+      path = ''
+      result_array.each do |result|
+        unless result.headline
+          result.headline = '-'
+        end
+
+        if result.name
+          path = "#{result.name}.#{@book.config['htmlext']}"
+          next
+        end
+
+        if result.part
+          if result.part == 'end'
+            content << "</ul></li>\n"
+          end
+          next
+        end
+
+        if path.start_with?('.')
+          content << "<li>#{escape(result.headline)}"
         else
-          @out.puts %Q(<li>#{h(I18n.t('part_short', part.number) + ' ' + part.title)}\n<ul>\n)
+          content << %Q(<li><a href="#{path}">#{escape(result.headline)}</a>)
+        end
+        if result.level == 0
+          content << "\n<ul>" # part
+        else
+          content << "</li>\n"
         end
       end
-      part.each_chapter do |chap|
-        print_chapter(chap)
-      end
-      if part.number
-        @out.puts "</ul>\n</li>\n"
-      end
-    end
-
-    def print_chapter(chap)
-      chap_node = TOCParser.chapter_node(chap)
-      ext = chap.book.config['htmlext'] || 'html'
-      path = File.basename(chap.path.sub(/\.re/, '.' + ext))
-      label = if chap_node.number && chap.on_chaps?
-                "#{I18n.t('chapter_short', chap.number)} #{chap.title}"
-              else
-                chap.title
-              end
-      @out.puts %Q(<li><a href="#{path}">#{h(label)}</a></li>\n)
+      content << "</ul>\n"
     end
   end
 end