review 4.2.0 → 5.0.0

data/lib/review/preprocessor.rb

@@ -195,7 +195,7 @@ module ReVIEW
       op = m[1]
       args = m[2].split(/,\s*/)
       opts = parse_optargs(m[3])
-      return if argc == 0 and args.empty?
+      return if (argc == 0) && args.empty?
       if argc == -1
         # Any number of arguments are allowed.
       elsif args.size != argc
@@ -284,7 +284,7 @@ module ReVIEW
           err = stderr.readlines
         end
       end
-      if err and !err.empty?
+      if err && !err.empty?
         $stderr.puts '[unexpected stderr message]'
         err.each { |line| $stderr.print line }
         error 'get_output: got unexpected output'
@@ -355,14 +355,14 @@ module ReVIEW
 
     def parse_git_blob(g_obj)
       IO.popen('git show ' + g_obj.sub(/\Agit\|/, ''), 'r') do |f|
-        init_errorutils f
+        init_errorutils(f)
         return _parse_file(f)
       end
     end
 
     def parse_file(fname)
       File.open(fname, 'rt:BOM|utf-8') do |f|
-        init_errorutils f
+        init_errorutils(f)
         return _parse_file(f)
       end
     end
@@ -426,7 +426,7 @@ module ReVIEW
           curr.each_value { |list| list.push(Line.new(nil, line)) }
 
         else
-          next if yacchack and line.strip == ';'
+          next if yacchack && (line.strip == ';')
           line = canonical(line)
           curr.each_value { |list| list.push(Line.new(lineno, line)) }
           lineno += 1

data/lib/review/rstbuilder.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.
@@ -86,7 +86,7 @@ module ReVIEW
     private :blank
 
     def result
-      @output.string
+      solve_nest(@output.string)
     end
 
     def headline(level, label, caption)
@@ -97,7 +97,7 @@ module ReVIEW
       end
       p = '='
       case level
-      when 1 then
+      when 1
         unless label
           puts ".. _#{@chapter.name}:"
           blank
@@ -373,8 +373,9 @@ module ReVIEW
 
     def compile_kw(word, alt)
       if alt
-        then " **#{word}（#{alt.strip}）** "
-      else " **#{word}** "
+        " **#{word}（#{alt.strip}）** "
+      else
+        " **#{word}** "
       end
     end
 
@@ -582,6 +583,24 @@ module ReVIEW
       base_parablock('centering', lines, nil)
     end
 
+    CAPTION_TITLES.each do |name|
+      class_eval %Q(
+        def #{name}_begin(caption = nil)
+          check_nested_minicolumn
+          @doc_status[:minicolumn] = '#{name}'
+          puts ".. #{name}::"
+          blank
+          puts "   " + compile_inline(caption).to_s unless caption.nil?
+          print "   "
+        end
+
+        def #{name}_end
+          blank
+          @doc_status[:minicolumn] = nil
+        end
+      ), __FILE__, __LINE__ - 14
+    end
+
     def note(lines, caption = nil)
       base_parablock('note', lines, caption)
     end
@@ -705,7 +724,7 @@ module ReVIEW
       str
     end
 
-    def inline_chap(id)
+    def inline_chap(id) # rubocop:disable Lint/UselessMethodDefinition
       super
     end
 

data/lib/review/sec_counter.rb

@@ -37,6 +37,19 @@ module ReVIEW
       str
     end
 
+    def number_list
+      buf = @counter.dup
+      while buf.present?
+        if buf.last == 0
+          buf.pop
+        else
+          return buf
+        end
+      end
+
+      buf
+    end
+
     def prefix(level, secnolevel)
       return nil if @chapter.number.blank?
 

data/lib/review/textmaker.rb

@@ -75,20 +75,13 @@ module ReVIEW
     end
 
     def execute(*args)
-      @config = ReVIEW::Configure.values
-      @config.maker = 'textmaker'
       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: 'textmaker',
+                                         yamlfile: yamlfile,
+                                         config: cmd_config)
 
-      # YAML configs will be overridden by command line options.
-      @config.deep_merge!(cmd_config)
       I18n.setup(@config['language'])
       begin
         generate_text_files(yamlfile)
@@ -109,8 +102,7 @@ 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)
 
       build_body(@path, yamlfile)
     end

data/lib/review/tocprinter.rb

@@ -50,7 +50,7 @@ module ReVIEW
       @logger = ReVIEW.logger
       @config = ReVIEW::Configure.values
       @yamlfile = 'config.yml'
-      @book = ReVIEW::Book::Base.load
+      @book = ReVIEW::Book::Base.new('.', config: @config)
       @upper = 4
       @indent = true
       @buildonly = nil
@@ -59,7 +59,6 @@ module ReVIEW
 
     def execute(*args)
       parse_options(args)
-      @book.config = ReVIEW::Configure.values
       unless File.readable?(@yamlfile)
         @logger.error("No such fiile or can't open #{@yamlfile}.")
         exit 1
@@ -108,7 +107,7 @@ module ReVIEW
             result_array.push({ part: 'end' })
           end
         end
-      rescue ReVIEW::FileNotFound => e
+      rescue ReVIEW::FileNotFound, ReVIEW::CompileError => e
         @logger.error e
         exit 1
       end

data/lib/review/topbuilder.rb

@@ -444,6 +444,32 @@ 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?

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
 
@@ -513,11 +513,11 @@ 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 +537,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.2.0'.freeze
+  VERSION = '5.0.0'.freeze
 end

data/lib/review/volumeprinter.rb

@@ -28,8 +28,7 @@ module ReVIEW
 
     def execute(*args)
       parse_options(args)
-      @book = ReVIEW::Book::Base.load
-      @book.config = @config
+      @book = ReVIEW::Book::Base.new('.', config: @config)
       unless File.readable?(@yamlfile)
         @logger.error("No such fiile or can't open #{@yamlfile}.")
         exit 1
@@ -46,7 +45,7 @@ module ReVIEW
             print_chapter_volume(chap)
           end
         end
-      rescue ReVIEW::FileNotFound => e
+      rescue ReVIEW::FileNotFound, ReVIEW::CompileError => e
         @logger.error e
         exit 1
       end

data/lib/review/webmaker.rb

@@ -19,7 +19,6 @@ require 'review/yamlloader'
 require 'review/template'
 require 'review/tocprinter'
 require 'review/version'
-require 'erb'
 require 'review/makerhelper'
 
 module ReVIEW
@@ -80,19 +79,13 @@ module ReVIEW
     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'
       I18n.setup(@config['language'])
       begin
@@ -109,8 +102,7 @@ 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)
 
       copy_stylesheet(@path)
       copy_frontmatter(@path)
@@ -129,12 +121,6 @@ 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
@@ -156,6 +142,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)
@@ -259,6 +246,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'])
@@ -281,10 +269,11 @@ module ReVIEW
     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

data/review.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |gem|
   gem.summary     = 'Re:VIEW: a easy-to-use digital publishing system'
   gem.description = 'Re:VIEW is a digital publishing system for books and ebooks. It supports InDesign, EPUB and LaTeX.'
   gem.required_rubygems_version = Gem::Requirement.new('>= 0') if gem.respond_to?(:required_rubygems_version=)
-  gem.date = '2020-06-29'
+  gem.date = '2020-10-29'
 
   gem.files         = `git ls-files`.split("\n")
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -25,7 +25,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency('rubyzip')
   gem.add_development_dependency('pygments.rb')
   gem.add_development_dependency('rake')
-  gem.add_development_dependency('rubocop', '~> 0.77.0')
+  gem.add_development_dependency('rubocop', '~> 0.92.0')
   gem.add_development_dependency('rubocop-performance')
   gem.add_development_dependency('simplecov')
   gem.add_development_dependency('test-unit')

data/samples/sample-book/src/config.yml

@@ -1,5 +1,5 @@
 ## config.yml for sample book
-review_version: 4.0
+review_version: 5.0
 bookname: book
 language: ja
 booktitle: Re:VIEWサンプル書籍

data/samples/syntax-book/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
 gem 'rake'
-gem 'review', '2.3.0'
+gem 'review', '4.2.0'

data/samples/syntax-book/config.yml

@@ -1,4 +1,4 @@
-review_version: 4.0
+review_version: 5.0
 bookname: syntax-book
 language: ja
 booktitle: {name: "Re:VIEW文法使用例", file-as: "リビューブンポウシヨウレイ"}

data/templates/latex/config.erb

@@ -1,50 +1,51 @@
+<%- initialize_metachars(@config['texcommand']) -%>
 \makeatletter
 \def\review@reviewversion{<%= ReVIEW::VERSION %>}
 \def\review@texcompiler{<%= @texcompiler %>}
 \def\review@documentclass{<%= @documentclass %>}
 
 <%- %w(booktitle subtitle).each do |item| -%>
-<%-   if @config[item] -%>\def\review@<%= item %>name{<%= escape_latex(@config.name_of(item)) %>}
+<%-   if @config[item] -%>\def\review@<%= item %>name{<%= escape(@config.name_of(item)) %>}
 <%-   end -%>
 <%- end -%>
 
-<%- %w(aut adp ann arr art asn aqt aft aui ant bkp clb cmm csl dsr edt ill lyr mdc mus nrt oth pht pbl prt red rev spn ths trc trl).each do |item| %><%-   if @config[item] -%>\def\review@<%= item %>names{<%= escape_latex(@config.names_of(item).join(I18n.t('names_splitter'))) %>}
+<%- %w(aut adp ann arr art asn aqt aft aui ant bkp clb cmm csl dsr edt ill lyr mdc mus nrt oth pht pbl prt red rev spn ths trc trl).each do |item| %><%-   if @config[item] -%>\def\review@<%= item %>names{<%= escape(@config.names_of(item).join(I18n.t('names_splitter'))) %>}
 <%-   end -%>
 <%- end -%>
 
 \def\review@titlepageauthors{<%= @authors %>}
-\def\review@date{<%= escape_latex(@config['date'].to_s) %>}
+\def\review@date{<%= escape(@config['date'].to_s) %>}
 
-<%- %w(bookname language urnid isbn).each do |item| -%><%-   if @config[item] -%>\def\review@<%= item %>{<%= escape_latex(@config[item]) %>}
+<%- %w(bookname language urnid isbn).each do |item| -%><%-   if @config[item] -%>\def\review@<%= item %>{<%= escape(@config[item]) %>}
 <%-   end -%>
 <%- end -%>
 <%- %w(rights description subject type format source relation coverage).each do |item| -%>
 <%-   if @config[item] -%>
-<%-     a = [@config[item]].flatten -%>\def\review@<%= item %>{<%= a.map{|s| escape_latex(s)}.join('\\' + '\\') %>}
+<%-     a = [@config[item]].flatten -%>\def\review@<%= item %>{<%= a.map{|s| escape(s)}.join('\\' + '\\') %>}
 <%-   end -%>
 <%- end -%>
 
 <%- if @config['highlight'] && @config['highlight']['latex'] -%>\def\review@highlightlatex{<%= @config['highlight']['latex'] %>}
 <%- end -%>
 
-\def\review@intn@list{<%= escape_latex(I18n.t('list')) %>}
-\def\review@intn@columnhead{<%= escape_latex(I18n.t('column_head')) %>}
-\def\review@intn@image{<%= escape_latex(I18n.t('image')) %>}
-\def\review@intn@table{<%= escape_latex(I18n.t('table')) %>}
-\def\review@intn@equation{<%= escape_latex(I18n.t('equation')) %>}
-\def\review@intn@columnname{<%= escape_latex(I18n.t('columnname')) %>}
-\def\review@intn@memohead{<%= escape_latex(I18n.t('memo_head')) %>}
-\def\review@intn@edition{<%= escape_latex(I18n.t('edition')) %>}
-\def\review@intn@publishedby{<%= escape_latex(I18n.t('published_by', @config.names_of('pbl').join(I18n.t('names_splitter'))))%>}
-\def\review@intn@captionprefix{<%= escape_latex(I18n.t('caption_prefix')) %>}
-\def\review@toctitle{<%= escape_latex(@config['toctitle'].present? ? @config['toctitle'] : I18n.t('toctitle')) %>}
-\def\review@prepartname{<%= escape_latex(@locale_latex['prepartname']) %>}
-\def\review@postpartname{<%= escape_latex(@locale_latex['postpartname']) %>}
-\def\review@prechaptername{<%= escape_latex(@locale_latex['prechaptername']) %>}
-\def\review@postchaptername{<%= escape_latex(@locale_latex['postchaptername']) %>}
-\def\review@figurename{<%= escape_latex(I18n.t('image')) %>}
-\def\review@tablename{<%= escape_latex(I18n.t('table')) %>}
-\def\review@appendixname{<%= escape_latex(@locale_latex['preappendixname']) %>}
+\def\review@intn@list{<%= escape(I18n.t('list')) %>}
+\def\review@intn@columnhead{<%= escape(I18n.t('column_head')) %>}
+\def\review@intn@image{<%= escape(I18n.t('image')) %>}
+\def\review@intn@table{<%= escape(I18n.t('table')) %>}
+\def\review@intn@equation{<%= escape(I18n.t('equation')) %>}
+\def\review@intn@columnname{<%= escape(I18n.t('columnname')) %>}
+\def\review@intn@memohead{<%= escape(I18n.t('memo_head')) %>}
+\def\review@intn@edition{<%= escape(I18n.t('edition')) %>}
+\def\review@intn@publishedby{<%= escape(I18n.t('published_by', @config.names_of('pbl').join(I18n.t('names_splitter'))))%>}
+\def\review@intn@captionprefix{<%= escape(I18n.t('caption_prefix')) %>}
+\def\review@toctitle{<%= escape(@config['toctitle'].present? ? @config['toctitle'] : I18n.t('toctitle')) %>}
+\def\review@prepartname{<%= escape(@locale_latex['prepartname']) %>}
+\def\review@postpartname{<%= escape(@locale_latex['postpartname']) %>}
+\def\review@prechaptername{<%= escape(@locale_latex['prechaptername']) %>}
+\def\review@postchaptername{<%= escape(@locale_latex['postchaptername']) %>}
+\def\review@figurename{<%= escape(I18n.t('image')) %>}
+\def\review@tablename{<%= escape(I18n.t('table')) %>}
+\def\review@appendixname{<%= escape(@locale_latex['preappendixname']) %>}
 
 <%- if @config['toc'] -%>
 \def\review@toc{true}
@@ -100,6 +101,9 @@
 <%- if @config['use_part'] -%>
 \def\reviewusepart{true}
 <%- end -%>
+<%- if @config['pdfmaker']['bbox'] -%>
+\def\review@bbox{<%= @config['pdfmaker']['bbox'] %>}
+<%- end -%>
 
 \def\reviewbackcompatibilityhook{
   \ifdefined\reviewimagecaption\else% for 3.0.0 compatibility