review 5.0.0 → 5.1.0

data/doc/quickstart.ja.md

@@ -8,7 +8,7 @@ Re:VIEW は GNU Lesser General Public License Version 2.1 に基づいて配布
 
 このドキュメントでは、Re:VIEW のセットアップから変換の例までを簡単に説明します。
 
-このドキュメントは、Re:VIEW 4.2 に基づいています。
+このドキュメントは、Re:VIEW 5.1 に基づいています。
 
 ## セットアップ
 
@@ -160,6 +160,16 @@ config.yml のサンプルについては以下を参照してください。
 
 * [config.yml.sample](https://github.com/kmuto/review/blob/master/doc/config.yml.sample)
 
+#### Vivliostyle CLI を使った PDF 化
+
+TeX (`review-pdfmaker`、`rake pdf`) を利用する代わりに、[Vivliostyle CLI](https://github.com/vivliostyle/vivliostyle-cli) を使って PDF を作成することもできます。Re:VIEW が EPUB を作成したあと、VivliostyleCLI がそれを PDF に変換します。
+
+```bash
+$ rake vivliostyle:build    ← Vivliostyle を使って PDF を作成
+$ rake vivliostyle:preview  ← Chrome/Chromium ブラウザでプレビュー
+$ rake vivliostyle          ← vivliostyle:buildのショートカット
+```
+
 ### 章を増やす、カスタマイズする
 作成した PDF あるいは EPUB を見ると、先に作成した RE:VIEW フォーマットテキストファイルが「第1章」となっていることがわかります。
 

data/doc/quickstart.md

@@ -9,7 +9,7 @@ Re:VIEW is free software under the terms of the GNU Lesser General Public Licens
 
 This article describes how to setup Re:VIEW and use it.
 
-The supported version of the article is Re:VIEW 4.2.
+The supported version of the article is Re:VIEW 5.1.
 
 ## Set up Re:VIEW
 
@@ -161,6 +161,16 @@ $ rake idgxml    ## generate InDesign XML
 
 There is a sample YAML file [config.yml.sample](https://github.com/kmuto/review/blob/master/doc/config.yml.sample) in the same directory of this document.
 
+#### generate PDF using Vivliostyle CLI
+
+Instead of using TeX (`review-pdfmaker` or `rake pdf`), you can also create a PDF use [Vivliostyle CLI](https://github.com/vivliostyle/vivliostyle-cli). Re:VIEW creates EPUB first and then converts it to PDF with Vivliostyle CLI.
+
+```bash
+$ rake vivliostyle:build    ## build PDF using Viliostyle
+$ rake vivliostyle:preview  ## preview pages in Chrome/Chromium browser
+$ rake vivliostyle          ## shortcut of vivliostyle:build
+```
+
 ### add chapters and modify them
 
 `catalog.yml` file is a catalog of Re:VIEW format files.
@@ -182,7 +192,6 @@ POSTDEF:
 
 The first item in CHAPS is the first chapter, and the second item (if you add) is the second chapter. PREDEF is for front matter, APPENDIX is for appendix, and POSTDEF is for back matter.  You can see in detail with [catalog.md](https://github.com/kmuto/review/blob/master/doc/catalog.ja.md).
 
-
 ### more information
 
 For more information about Re:VIEW format, see [format.md](https://github.com/kmuto/review/blob/master/doc/format.md).

data/lib/review.rb

@@ -1,3 +1,3 @@
-Dir["#{File.dirname(__FILE__)}/review/*.rb"].sort.each do |path|
+Dir["#{__dir__}/review/*.rb"].sort.each do |path|
   require "review/#{File.basename(path, '.rb')}"
 end

data/lib/review/book/base.rb

@@ -176,6 +176,7 @@ module ReVIEW
 
       def chapter_index
         return @chapter_index if @chapter_index
+
         @chapter_index = create_chapter_index
         @chapter_index
       end
@@ -188,6 +189,7 @@ module ReVIEW
         finded = false
         each_chapter do |c|
           return c if finded
+
           if c == chapter
             finded = true
           end
@@ -199,6 +201,7 @@ module ReVIEW
         finded = false
         each_chapter_r do |c|
           return c if finded
+
           if c == chapter
             finded = true
           end
@@ -392,6 +395,7 @@ module ReVIEW
         File.open(filename_join(@basedir, filename), 'rt:BOM|utf-8') do |f|
           f.each_line do |line|
             next if line.start_with?('#')
+
             line.gsub!(/#.*\Z/, '')
             res << line
           end

data/lib/review/book/book_unit.rb

@@ -82,6 +82,7 @@ module ReVIEW
 
         @title = ''
         return @title unless content
+
         content.each_line do |line|
           if line =~ /\A=+/
             @title = line.sub(/\A=+(\[.+?\])?(\{.+?\})?/, '').strip
@@ -119,6 +120,7 @@ module ReVIEW
         return image_index[id] if image_index.key?(id)
         return icon_index[id] if icon_index.key?(id)
         return numberless_image_index[id] if numberless_image_index.key?(id)
+
         indepimage_index[id]
       end
 
@@ -128,6 +130,7 @@ module ReVIEW
 
       def bibpaper_index
         raise FileNotFound, "no such bib file: #{@book.bib_file}" unless @book.bib_exist?
+
         @book.bibpaper_index
       end
 

data/lib/review/book/chapter.rb

@@ -20,6 +20,7 @@ module ReVIEW
         name += book.ext if File.extname(name).empty?
         path = File.join(book.contentdir, name)
         raise FileNotFound, "file not exist: #{path}" unless File.file?(path)
+
         Chapter.new(book, number, name, path)
       end
 
@@ -85,6 +86,8 @@ module ReVIEW
           nil
         rescue ArgumentError => e
           raise ReVIEW::CompileError, "#{@name}: #{e}"
+        rescue SyntaxError => e
+          raise ReVIEW::SyntaxError, "#{@name}:#{f.lineno}: #{e}"
         end
       end
 

data/lib/review/book/index.rb

@@ -189,6 +189,7 @@ module ReVIEW
           # when notoc
           return ''
         end
+
         n = @chapter.number
         # XXX: remove magic number (move to lib/review/book/chapter.rb)
         if @chapter.on_appendix? && @chapter.number > 0 && @chapter.number < 28

data/lib/review/book/volume.rb

@@ -13,6 +13,7 @@ module ReVIEW
         b = c = l = 0
         File.foreach(path) do |line|
           next if /\A\#@/ =~ line
+
           text = line.gsub(/\s+/, '')
           b += text.bytesize
           c += text.size

data/lib/review/builder.rb

@@ -10,6 +10,7 @@ require 'review/exception'
 require 'review/textutils'
 require 'review/compiler'
 require 'review/sec_counter'
+require 'review/img_math'
 require 'stringio'
 require 'fileutils'
 require 'tempfile'
@@ -31,13 +32,14 @@ module ReVIEW
 
     attr_accessor :doc_status, :previous_list_type
 
-    def initialize(strict = false, *_args)
+    def initialize(strict = false, *_args, img_math: nil)
       @strict = strict
       @output = nil
       @logger = ReVIEW.logger
       @doc_status = {}
       @dictionary = {}
       @previous_list_type = nil
+      @img_math = img_math
     end
 
     def bind(compiler, chapter, location)
@@ -55,6 +57,7 @@ module ReVIEW
       @tabwidth = nil
       @tsize = nil
       if @book && @book.config
+        @img_math ||= ReVIEW::ImgMath.new(@book.config)
         if words_file_path = @book.config['words_file']
           if words_file_path.is_a?(String)
             words_files = [words_file_path]
@@ -145,6 +148,7 @@ module ReVIEW
 
     def line_num
       return 1 unless @first_line_num
+
       line_n = @first_line_num
       @first_line_num = nil
 
@@ -514,11 +518,13 @@ module ReVIEW
 
     def parse_metric(type, metric)
       return '' if metric.blank?
+
       params = metric.split(/,\s*/)
       results = []
       params.each do |param|
         if param =~ /\A.+?::/
           next unless param =~ /\A#{type}::/
+
           param.sub!(/\A#{type}::/, '')
         end
         param2 = handle_metric(param)
@@ -543,6 +549,7 @@ module ReVIEW
       if m
         ch = @book.contents.detect { |chap| chap.id == m[1] }
         raise KeyError unless ch
+
         return [ch, m[2]]
       end
       [@chapter, chap_ref]

data/lib/review/call_hook.rb

@@ -0,0 +1,20 @@
+module ReVIEW
+  module CallHook
+    def call_hook(hook_name, *params, base_dir: nil)
+      maker = @config.maker
+      filename = @config.dig(maker, hook_name)
+      return unless filename
+
+      hook = File.absolute_path(filename, base_dir)
+      @logger.debug("Call #{hook_name}. (#{hook})")
+
+      return if !File.exist?(hook) || !FileTest.executable?(hook)
+
+      if ENV['REVIEW_SAFE_MODE'].to_i & 1 > 0
+        warn 'hook configuration is prohibited in safe mode. ignored.'
+      else
+        system(hook, *params)
+      end
+    end
+  end
+end

data/lib/review/catalog.rb

@@ -50,6 +50,7 @@ module ReVIEW
 
     def parts_with_chaps
       return [] unless @yaml['CHAPS']
+
       @yaml['CHAPS'].flatten.compact
     end
 

data/lib/review/compiler.rb

@@ -14,6 +14,8 @@ require 'strscan'
 
 module ReVIEW
   class Compiler
+    MAX_HEADLINE_LEVEL = 6
+
     def initialize(builder)
       @builder = builder
 
@@ -59,6 +61,7 @@ module ReVIEW
         unless @argc_spec === args.size
           raise CompileError, "wrong # of parameters (block command //#{@name}, expect #{@argc_spec} but #{args.size})"
         end
+
         if @checker
           @checker.call(*args)
         end
@@ -331,6 +334,8 @@ module ReVIEW
         end
       end
       close_all_tagged_section
+    rescue SyntaxError => e
+      error e
     end
 
     def compile_minicolumn_begin(name, caption = nil)
@@ -364,24 +369,28 @@ module ReVIEW
       @headline_indexs ||= [@chapter.number.to_i - 1]
       m = /\A(=+)(?:\[(.+?)\])?(?:\{(.+?)\})?(.*)/.match(line)
       level = m[1].size
+      if level > MAX_HEADLINE_LEVEL
+        raise CompileError, "Invalid header: max headline level is #{MAX_HEADLINE_LEVEL}"
+      end
+
       tag = m[2]
       label = m[3]
       caption = m[4].strip
       index = level - 1
       if tag
-        if tag !~ %r{\A/}
-          if caption.empty?
-            warn 'headline is empty.'
-          end
-          close_current_tagged_section(level)
-          open_tagged_section(tag, level, label, caption)
-        else
+        if tag.start_with?('/')
           open_tag = tag[1..-1]
           prev_tag_info = @tagged_section.pop
           if prev_tag_info.nil? || prev_tag_info.first != open_tag
             error "#{open_tag} is not opened."
           end
           close_tagged_section(*prev_tag_info)
+        else
+          if caption.empty?
+            warn 'headline is empty.'
+          end
+          close_current_tagged_section(level)
+          open_tagged_section(tag, level, label, caption)
         end
       else
         if caption.empty?
@@ -504,7 +513,10 @@ module ReVIEW
         @builder.doc_status[:dt] = true
         @builder.dt(text(f.gets.sub(/\A\s*:/, '').strip))
         @builder.doc_status[:dt] = nil
-        desc = f.break(/\A(\S|\s*:|\s+\d+\.\s|\s+\*\s)/).map { |line| text(line.strip) }
+        desc = []
+        f.until_match(/\A(\S|\s*:|\s+\d+\.\s|\s+\*\s)/) do |line|
+          desc << text(line.strip)
+        end
         @builder.dd(desc)
         f.skip_blank_lines
         f.skip_comment_lines
@@ -516,6 +528,7 @@ module ReVIEW
       buf = []
       f.until_match(%r{\A//|\A\#@}) do |line|
         break if line.strip.empty?
+
         buf.push(text(line.sub(/^(\t+)\s*/) { |m| '<!ESCAPETAB!>' * m.size }.strip.gsub('<!ESCAPETAB!>', "\t")))
       end
       @builder.paragraph(buf)
@@ -557,6 +570,7 @@ module ReVIEW
 
     def parse_args(str, _name = nil)
       return [] if str.empty?
+
       scanner = StringScanner.new(str)
       words = []
       while word = scanner.scan(/(\[\]|\[.*?[^\\]\])/)
@@ -621,13 +635,13 @@ module ReVIEW
         if arg =~ /[\x01\x02\x03\x04]/
           error "invalid character in '#{str}'"
         end
-        replaced = arg.gsub('@', "\x01").gsub('\\', "\x02").gsub('{', "\x03").gsub('}', "\x04")
+        replaced = arg.tr('@', "\x01").tr('\\', "\x02").tr('{', "\x03").tr('}', "\x04")
         "@<#{op}>{#{replaced}}"
       end
     end
 
     def revert_replace_fence(str)
-      str.gsub("\x01", '@').gsub("\x02", '\\').gsub("\x03", '{').gsub("\x04", '}')
+      str.tr("\x01", '@').tr("\x02", '\\').tr("\x03", '{').tr("\x04", '}')
     end
 
     def in_non_escaped_command?
@@ -637,6 +651,7 @@ module ReVIEW
 
     def text(str, block_mode = false)
       return '' if str.empty?
+
       words = replace_fence(str).split(/(@<\w+>\{(?:[^}\\]|\\.)*?\})/, -1)
       words.each do |w|
         if w.scan(/@<\w+>/).size > 1 && !/\A@<raw>/.match(w)
@@ -651,6 +666,7 @@ module ReVIEW
           result << @builder.nofunc_text(revert_replace_fence(words.shift))
         end
         break if words.empty?
+
         result << compile_inline(revert_replace_fence(words.shift.gsub(/\\\}/, '}').gsub(/\\\\/, '\\')))
       end
       result
@@ -667,6 +683,7 @@ module ReVIEW
       unless @builder.respond_to?("inline_#{op}")
         raise "builder does not support inline op: @<#{op}>"
       end
+
       @builder.__send__("inline_#{op}", arg)
     rescue => e
       error e.message

data/lib/review/configure.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2012-2020 Masanori Kado, Masayoshi Takahashi, Kenshi Muto
+# Copyright (c) 2012-2021 Masanori Kado, Masayoshi Takahashi, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -7,12 +7,13 @@
 # For details of the GNU LGPL, see the file "COPYING".
 #
 require 'securerandom'
+require 'review/yamlloader'
 
 module ReVIEW
   class Configure < Hash
     attr_accessor :maker
 
-    def self.values
+    def self.values # rubocop:disable Metrics/MethodLength
       conf = Configure[
         # These parameters can be overridden by YAML file.
         'bookname' => 'book', # it defines epub file name also
@@ -31,7 +32,7 @@ module ReVIEW
         'date' => Time.now.strftime('%Y-%m-%d'), # publishing date
         'rights' => nil, # Copyright messages
         'description' => nil, # Description
-        'urnid' => "urn:uid:#{SecureRandom.uuid}", # Identifier
+        'urnid' => "urn:uuid:#{SecureRandom.uuid}", # Identifier
         'stylesheet' => [], # stylesheet file
         'coverfile' => nil, # content file of body of cover page
         'mytoc' => nil, # whether make own table of contents or not
@@ -45,8 +46,7 @@ module ReVIEW
         'debug' => nil, # debug flag
         'catalogfile' => 'catalog.yml',
         'language' => 'ja', # XXX default language should be JA??
-        'mathml' => nil, # for HTML
-        'imgmath' => nil, # for HTML
+        'math_format' => nil,
         'htmlext' => 'html',
         'htmlversion' => 5,
         'contentdir' => '.',
@@ -63,7 +63,7 @@ module ReVIEW
         'image_types' => %w[.ai .psd .eps .pdf .tif .tiff .png .bmp .jpg .jpeg .gif .svg],
         'bib_file' => 'bib.re',
         'words_file' => nil,
-        'colophon_order' => %w[aut csl trl dsr ill cov edt pbl contact prt],
+        'colophon_order' => %w[aut csl trl dsr ill cov edt pbl contact prt pht],
         'chapterlink' => true,
         'externallink' => true,
         'join_lines_by_lang' => nil, # experimental. default should be nil
@@ -113,6 +113,34 @@ module ReVIEW
           'image' => 'bottom',
           'table' => 'top',
           'equation' => 'top'
+        },
+        # for EPUBMaker
+        'modified' => Time.now.utc.strftime('%Y-%02m-%02dT%02H:%02M:%02SZ'),
+        'isbn' => nil,
+        'titlefile' => nil,
+        'originaltitlefile' => nil,
+        'profile' => nil,
+        'direction' => 'ltr',
+        'image_maxpixels' => 4_000_000,
+        'font_ext' => %w[ttf woff otf],
+        'epubmaker' => {
+          'flattoc' => nil,
+          'flattocindent' => true,
+          'ncx_indent' => [],
+          'zip_stage1' => 'zip -0Xq',
+          'zip_stage2' => 'zip -Xr9Dq',
+          'zip_addpath' => nil,
+          'hook_beforeprocess' => nil,
+          'hook_afterfrontmatter' => nil,
+          'hook_afterbody' => nil,
+          'hook_afterbackmatter' => nil,
+          'hook_aftercopyimage' => nil,
+          'hook_prepack' => nil,
+          'rename_for_legacy' => nil,
+          'verify_target_images' => nil,
+          'force_include_images' => [],
+          'cover_linear' => nil,
+          'back_footnote' => nil
         }
       ]
       conf.maker = nil
@@ -128,17 +156,45 @@ module ReVIEW
           loader = ReVIEW::YAMLLoader.new
           conf.deep_merge!(loader.load_file(yamlfile))
         rescue => e
-          error "yaml error #{e.message}"
+          raise ReVIEW::ConfigError, "yaml error #{e.message}"
         end
       end
+
       # YAML configs will be overridden by command line options.
       if config
         conf.deep_merge!(config)
       end
 
+      conf.migrate_parameters
+
       conf
     end
 
+    def migrate_parameters
+      # string to array
+      %w[subject aut
+         a-adp a-ann a-arr a-art a-asn a-aqt a-aft a-aui a-ant a-bkp a-clb a-cmm a-dsr a-edt
+         a-ill a-lyr a-mdc a-mus a-nrt a-oth a-pht a-prt a-red a-rev a-spn a-ths a-trc a-trl
+         adp ann arr art asn aut aqt aft aui ant bkp clb cmm dsr edt
+         ill lyr mdc mus nrt oth pht pbl prt red rev spn ths trc trl
+         stylesheet rights].each do |item|
+        if self[item] && self[item].is_a?(String)
+          self[item] = [self[item]]
+        end
+      end
+
+      # backward compatibility
+      if self['mathml']
+        warn '"mathml: true" is obsoleted. Please use "math_format: mathml"'
+        self['math_format'] = 'mathml'
+      end
+
+      if self['imgmath']
+        warn '"imgmath: true" is obsoleted. Please use "math_format: imgmath"'
+        self['math_format'] = 'imgmath'
+      end
+    end
+
     def [](key)
       maker = self.maker
       if maker && self.key?(maker) && self.fetch(maker) && self.fetch(maker).key?(key)
@@ -147,6 +203,7 @@ module ReVIEW
       if self.key?(key)
         return self.fetch(key)
       end
+
       nil
     end