review 5.1.1 → 5.4.0

data/bin/review-preproc

@@ -16,13 +16,17 @@ require 'review/version'
 require 'review/extentions'
 require 'review/logger'
 require 'review/lineinput'
+require 'review/loggable'
 require 'stringio'
 require 'fileutils'
 require 'optparse'
+require 'tempfile'
+
+include ReVIEW::Loggable
 
 def sigmain
   Signal.trap(:INT) { exit 1 }
-  if RUBY_PLATFORM !~ /mswin(?!ce)|mingw|cygwin|bccwin/
+  unless RUBY_PLATFORM.match?(/mswin(?!ce)|mingw|cygwin|bccwin/)
     Signal.trap(:PIPE, 'IGNORE')
   end
   main
@@ -30,16 +34,7 @@ rescue Errno::EPIPE
   exit 0
 end
 
-def main
-  @logger = ReVIEW.logger
-  if File.file?('review-preproc-ext.rb')
-    if ENV['REVIEW_SAFE_MODE'].to_i & 2 > 0
-      @logger.warn 'review-preproc-ext.rb is prohibited in safe mode. ignored.'
-    else
-      Kernel.load(File.expand_path('review-preproc-ext.rb'))
-    end
-  end
-
+def parse_options
   param = {}
 
   mode = :output
@@ -57,32 +52,42 @@ def main
   begin
     opts.parse!
   rescue OptionParser::ParseError => e
-    @logger.error e.message
+    error e.message
     $stderr.puts opts.help
     exit 1
   end
 
-  pp = ReVIEW::Preprocessor.new(ReVIEW::Repository.new(param), param)
-  current_file = nil
+  [param, mode]
+end
+
+def main
+  @logger = ReVIEW.logger
+  if File.file?('review-preproc-ext.rb')
+    if ENV['REVIEW_SAFE_MODE'].to_i & 2 > 0
+      warn 'review-preproc-ext.rb is prohibited in safe mode. ignored.'
+    else
+      Kernel.load(File.expand_path('review-preproc-ext.rb'))
+    end
+  end
+
+  param, mode = parse_options
+  pp = ReVIEW::Preprocessor.new(param)
   ARGV.each do |path|
-    current_file = path
     case mode
     when :output
-      File.open(path) { |f| pp.process(f, $stdout) }
+      $stdout.write(pp.process(path))
     when :replace
-      File.write("#{path}.pptmp", preproc(pp, path))
-      File.rename("#{path}.pptmp", path)
+      output = pp.process(path)
+      File.write(path, output)
     when :diff, :check
-      tmp = '/tmp/review.pptmp'
-      begin
-        File.write(tmp, preproc(pp, path))
+      Tempfile.create('review.pptmp') do |tmp_io|
+        tmp = tmp_io.path
+        tmp_io.write(pp.process(path))
         if mode == :check
           system("diff -qu #{path} #{tmp} >/dev/null || echo #{path}")
         else
           system("diff -u #{path} #{tmp}")
         end
-      ensure
-        FileUtils.rm_f(tmp)
       end
     else
       raise "must not happen: #{mode}"
@@ -91,18 +96,7 @@ def main
 rescue ReVIEW::Error => e
   raise if $DEBUG
 
-  @logger.error e.message
-  exit 1
-end
-
-def preproc(pp, path)
-  buf = StringIO.new
-  File.open(path) { |f| pp.process(f, buf) }
-  buf.string
-end
-
-def File.write(path, str)
-  File.open(path, 'w') { |f| f.write str }
+  error! e.message
 end
 
 sigmain

data/bin/review-validate

@@ -41,7 +41,7 @@ ARGF.each do |line|
     unless %w[list emlist listnum emlistnum cmd image table].include?(block)
       @logger.warn "#{ln}: found '#{$1}' without the head space. Is it correct?"
     end
-  elsif line =~ /\A\*\s+/
+  elsif /\A\*\s+/.match?(line)
     # itemize
     unless %w[list emlist listnum emlistnum cmd image table].include?(block)
       @logger.warn "#{ln}: found '*' without the head space. Is it correct?"
@@ -53,7 +53,7 @@ ARGF.each do |line|
   elsif block == 'table'
     next if line.start_with?('#@')
 
-    if line !~ /\A-----/
+    unless line.start_with?('-----')
       # table
       colcount = line.split("\t").size
       if maxcolcount == 0

data/doc/config.yml.sample

@@ -87,7 +87,7 @@ aut: ["青木峰郎", "武藤健志", "高橋征義", "角征典"]
 debug: null
 
 # 固有IDに使用するドメイン。指定しない場合には、時刻に基づくランダムUUIDが入る
-# urnid: urn:uuid:http://example.com/book-title/
+# urnid: urn:uuid:ffffffff-ffff-ffff-ffff-ffffffffffff
 #
 # ISBN。省略した場合はurnidが入る
 # isbn: null
@@ -341,6 +341,8 @@ epubmaker:
   #
   # 脚注に「戻る」リンクを追加する(trueで追加)。脚注の記号および戻るリンクの記号はlocale.ymlで変更可能
   # back_footnote: null
+  # 見出しに応じて<section>で囲むようにする(trueで<section>を利用)
+  # use_section: null
   # epubmaker:階層を使うものはここまで
 
 # LaTeX用のスタイルファイル(styディレクトリ以下に置くこと)
@@ -440,3 +442,9 @@ pdfmaker:
   #     options_with_caption: "colbacktitle=black!25!white"
   #
   # pdfmaker:階層を使うものはここまで
+# textmaker:
+  # 表見出しの表現の設定
+  # nullの場合は区切り線（------------）で見出し行と通常の行を分ける。
+  # trueの場合は見出しを★〜☆で囲み（太字と同様）、区切り線を入れない。
+  # th_bold: null
+  # textmaker:階層を使うものはここまで

data/doc/config.yml.sample-simple

@@ -25,7 +25,7 @@ date: 2018-11-11
 history: [["2012-01-30"],["2016-04-20","2016-05-03"],["2018-11-11"]]
 rights: (C) 2016-2020 Re:VIEW Commiters, some rights reserved.
 description: sample config.yml file for Re:VIEW book
-urnid: urn:uuid:http://reviewml.org/review-sample-book
+# urnid: urn:uuid:ffffffff-ffff-ffff-ffff-ffffffffffff
 # isbn: null
 
 ## Book Structure

data/doc/format.ja.md

@@ -2,7 +2,7 @@
 
 Re:VIEW フォーマットの文法について解説します。Re:VIEW フォーマットはアスキー社（現カドカワ）の EWB を基本としながら、一部に RD や各種 Wiki の文法を取り入れて簡素化しています。
 
-このドキュメントは、Re:VIEW 5.1 に基づいています。
+このドキュメントは、Re:VIEW 5.3 に基づいています。
 
 ## 段落
 
@@ -396,7 +396,7 @@ plot sin(x)
 * Gnuplot ( http://www.gnuplot.info/ ) : `gnuplot` コマンドへのパスを OS に設定すること
 * Blockdiag ( http://blockdiag.com/ ) : `blockdiag` コマンドへのパスを OS に設定すること。PDF を生成する場合は ReportLab もインストールすること
 * aafigure ( https://launchpad.net/aafigure ) : `aafigure` コマンドへのパスを OS に設定すること
-* PlantUML ( http://plantuml.com/ ) : `java` コマンドへのパスを OS に設定し、`plantuml.jar` が作業フォルダにあること
+* PlantUML ( http://plantuml.com/ ) : `java` コマンドへのパスを OS に設定し、`plantuml.jar` が作業フォルダ、または `/usr/share/plantuml` あるいは `/usr/share/java` フォルダにあること
 
 ## 表
 
@@ -524,6 +524,7 @@ Re:VIEW 5.0 以降では、囲み記事に箇条書きや図表・リストを
 ```
 パッケージは本書のサポートサイトから入手できます@<fn>{site}。
 各自ダウンロードしてインストールしておいてください。
+
 //footnote[site][本書のサポートサイト： http://i.loveruby.net/ja/stdcompiler ]
 ```
 
@@ -538,6 +539,31 @@ TeX PDF において、コラム以外の `//note` などの囲み記事の中
 
 ただし、通常の脚注（footnote）ではなく、footnotemark と footnotetext を使うため、本文と脚注が別ページに分かれる可能性があるなど、いろいろな制約があります。また、採番が別々になるため、footnote と footnotemark/footnotetext を両立させることはできません。
 
+## 後注
+
+後注（最後にまとめて出力される注釈）は、「`//endnote`」を使って記述します。
+
+```
+パッケージは本書のサポートサイトから入手できます@<endnote>{site}。
+各自ダウンロードしてインストールしておいてください。
+
+//endnote[site][本書のサポートサイト： http://i.loveruby.net/ja/stdcompiler ]
+```
+
+本文中のインライン命令「`@<endnote>{site}`」は後注番号に置換され、「本書のサポートサイト……」という文は後注として内部に保存されます。
+
+保存されている後注を書き出すには、書き出したい箇所（通常は章の末尾）に「`//printendnotes`」を置きます。
+
+```
+ …
+
+==== 注釈
+
+//printendnotes
+```
+
+後注の管理は章 (re ファイル) 単位であり、複数の章にまたがった後注を作ることはできません。
+
 ## 参考文献の定義
 
 参考文献は同一ディレクトリ内の `bib.re` ファイルに定義します。
@@ -686,7 +712,7 @@ imgmath_options:
 math_format: imgmath
 imgmath_options:
   format: svg
-  pdfcrop_pixelize_cmd: "pdftocairo -svg -r 90 -f %p -l %p -singlefile %i %o"
+  pdfcrop_pixelize_cmd: "pdftocairo -%t -r 90 -f %p -l %p %i %o"
 ```
 
 デフォルトでは、pdfcrop_pixelize_cmd に指定するコマンドは、1ページあたり1数式からなる複数ページの PDF のファイル名を `%i` プレースホルダで受け取り、`%p` プレースホルダのページ数に基づいて `%o`（拡張子あり）または `%O`（拡張子なし）の画像ファイルに書き出す、という仕組みになっています。

data/doc/format.md

@@ -4,7 +4,7 @@ The document is a brief guide for Re:VIEW markup syntax.
 
 Re:VIEW is based on EWB of ASCII (now KADOKAWA), influenced RD and other Wiki system's syntax.
 
-This document explains about the format of Re:VIEW 5.1.
+This document explains about the format of Re:VIEW 5.3.
 
 ## Paragraph
 
@@ -423,7 +423,7 @@ Before using these tools, you should installed them and configured path appropri
 * Gnuplot ( http://www.gnuplot.info/ ) : set path to `gnuplot` command
 * Blockdiag ( http://blockdiag.com/ ) : set path to `blockdiag` command. Install ReportLab also to make a PDF
 * aafigure ( https://launchpad.net/aafigure ) : set path to `aafigure` command
-* PlantUML ( http://plantuml.com/ ) : set path to `java` command. place `plantuml.jar` on working folder
+* PlantUML ( http://plantuml.com/ ) : set path to `java` command. place `plantuml.jar` on working folder, `/usr/share/plantuml` or `/usr/share/java`.
 
 ## Tables
 
@@ -551,6 +551,7 @@ Usage:
 ```
 You can get the packages from support site for the book.@<fn>{site}
 You should get and install it before reading the book.
+
 //footnote[site][support site of the book: http://i.loveruby.net/ja/stdcompiler ]
 ```
 
@@ -572,6 +573,34 @@ Note that with this option, Re:VIEW use footnotemark and footnotetext instead of
 There are some constraints to use this option.
 You cannot use footnote and footnotemark/footnotetext at the same time.
 
+## Endnotes
+
+You can use `//endnote` to write endnotes.
+
+Usage:
+
+```
+You can get the packages from support site for the book.@<endnote>{site}
+You should get and install it before reading the book.
+
+//endnote[site][support site of the book: http://i.loveruby.net/ja/stdcompiler ]
+```
+
+`@<endnote>{site}` in source are replaced by endnote marks, and the phrase "support site of .."
+is stored for printing later.
+
+To print stored endnotes, place "`//printendnotes`" where you want to write down them (usually at the end of the chapter).
+
+```
+ ...
+
+==== Endnote
+
+//printendnotes
+```
+
+It is not possible to create an endnote that spans multiple chapters.
+
 ## Bibliography
 
 When you want to use a bibliography, you should write them in the file `bib.re`.
@@ -719,7 +748,7 @@ For example, to make SVG:
 math_format: imgmath
 imgmath_options:
   format: svg
-  pdfcrop_pixelize_cmd: "pdftocairo -svg -r 90 -f %p -l %p -singlefile %i %o"
+  pdfcrop_pixelize_cmd: "pdftocairo -%t -r 90 -f %p -l %p %i %o"
 ```
 
 By default, the command specified in `pdfcrop_pixelize_cmd` takes the filename of multi-page PDF consisting of one formula per page.

data/doc/writing_vertical.ja.md

@@ -35,6 +35,12 @@ body {
     -epub-writing-mode:   vertical-rl;
     writing-mode: tb-rl;
 }
+
+span.tcy {
+    -webkit-text-combine: horizontal;
+    -ms-text-combine-horizontal: all;
+    text-combine-upright: all;
+}
 ```
 
 また、縦書きの書籍は通常、「左開き」（右ページから左ページへ進む）となるので、config.yml の direction パラメータを設定します。

data/lib/review/book/base.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2009-2019 Minero Aoki, Kenshi Muto
+# Copyright (c) 2009-2022 Minero Aoki, Kenshi Muto, Masayoshi Takahashi
 #               2002-2008 Minero Aoki
 #
 # This program is free software.
@@ -214,7 +214,7 @@ module ReVIEW
       end
 
       def load_config(filename)
-        new_conf = YAML.load_file(filename)
+        new_conf = YAMLLoader.safe_load_file(filename)
         @config.merge!(new_conf)
       end
 
@@ -408,7 +408,7 @@ module ReVIEW
       end
 
       def filename_join(*args)
-        File.join(args.reject(&:nil?))
+        File.join(args.compact)
       end
     end
   end

data/lib/review/book/book_unit.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2009-2017 Minero Aoki, Kenshi Muto
+# Copyright (c) 2009-2021 Minero Aoki, Kenshi Muto
 #               2002-2008 Minero Aoki
 #
 # This program is free software.
@@ -18,7 +18,8 @@ module ReVIEW
       attr_reader :lines
       attr_accessor :content
 
-      attr_reader :list_index, :table_index, :equation_index, :footnote_index,
+      attr_reader :list_index, :table_index, :equation_index,
+                  :footnote_index, :endnote_index,
                   :numberless_image_index, :image_index, :icon_index, :indepimage_index,
                   :headline_index, :column_index
 
@@ -56,6 +57,7 @@ module ReVIEW
         @table_index = @indexes.table_index
         @equation_index = @indexes.equation_index
         @footnote_index = @indexes.footnote_index
+        @endnote_index = @indexes.endnote_index
         @headline_index = @indexes.headline_index
         @column_index = @indexes.column_index
         if use_bib
@@ -84,7 +86,7 @@ module ReVIEW
         return @title unless content
 
         content.each_line do |line|
-          if line =~ /\A=+/
+          if /\A=+/.match?(line)
             @title = line.sub(/\A=+(\[.+?\])?(\{.+?\})?/, '').strip
             break
           end
@@ -116,6 +118,14 @@ module ReVIEW
         footnote_index[id]
       end
 
+      def endnote(id)
+        endnote_index[id]
+      end
+
+      def endnotes
+        endnote_index
+      end
+
       def image(id)
         return image_index[id] if image_index.key?(id)
         return icon_index[id] if icon_index.key?(id)

data/lib/review/book/chapter.rb

@@ -42,7 +42,7 @@ module ReVIEW
         if @io
           begin
             @content = @io.read
-          rescue
+          rescue StandardError
             @content = nil
           end
         else

data/lib/review/book/index.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2019 Minero Aoki, Kenshi Muto
+# Copyright (c) 2008-2021 Minero Aoki, Kenshi Muto
 #               2002-2007 Minero Aoki
 #
 # This program is free software.
@@ -45,7 +45,7 @@ module ReVIEW
 
       def [](id)
         @index.fetch(id)
-      rescue
+      rescue StandardError
         index_keys = @index.keys.map { |i| i.split('|').last }.flatten # unfold all ids
         if index_keys.each_with_object(Hash.new(0)) { |i, h| h[i] += 1 }. # number of occurrences
            select { |k, v| k == id && v > 1 }.present? # detect duplicated
@@ -84,14 +84,14 @@ module ReVIEW
         begin
           chapter = chapter_item.content
           chapter.format_number
-        rescue # part
+        rescue StandardError # part
           I18n.t('part', chapter.number)
         end
       end
 
       def title(id)
         @index.fetch(id).content.title
-      rescue # non-file part
+      rescue StandardError # non-file part
         @index.fetch(id).content.name
       end
 
@@ -125,6 +125,9 @@ module ReVIEW
     class FootnoteIndex < Index
     end
 
+    class EndnoteIndex < Index
+    end
+
     class ImageIndex < Index
       def self.item_type
         '(image|graph|imgtable)'

data/lib/review/book/part.rb

@@ -14,11 +14,11 @@ module ReVIEW
       def self.mkpart_from_namelistfile(book, path)
         chaps = []
         File.read(path, mode: 'rt:BOM|utf-8').split.each_with_index do |name, number|
-          if path =~ /PREDEF/
-            chaps << Chapter.mkchap(book, name)
-          else
-            chaps << Chapter.mkchap(book, name, number + 1)
-          end
+          chaps << if /PREDEF/.match?(path)
+                     Chapter.mkchap(book, name)
+                   else
+                     Chapter.mkchap(book, name, number + 1)
+                   end
         end
         Part.mkpart(chaps)
       end
@@ -47,11 +47,11 @@ module ReVIEW
         else
           @content = ''
         end
-        if file?
-          @title = nil
-        else
-          @title = name
-        end
+        @title = if file?
+                   nil
+                 else
+                   name
+                 end
         @volume = nil
 
         super()
@@ -78,11 +78,10 @@ module ReVIEW
 
       def volume
         if @number && file?
-          vol = Volume.count_file(File.join(@book.config['contentdir'], @path))
+          Volume.count_file(File.join(@book.config['contentdir'], @path))
         else
-          vol = Volume.new(0, 0, 0)
+          Volume.new(0, 0, 0)
         end
-        vol
       end
 
       def file?

data/lib/review/book/volume.rb

@@ -12,7 +12,7 @@ module ReVIEW
       def self.count_file(path)
         b = c = l = 0
         File.foreach(path) do |line|
-          next if /\A\#@/ =~ line
+          next if /\A\#@/.match?(line)
 
           text = line.gsub(/\s+/, '')
           b += text.bytesize