review 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 364df2692f5e92ca2eaf1b327861324d6d964b1534d468c951476eb5603f1275
-  data.tar.gz: 57b1f560b2a08559596f6eb55d3f5af942bb5712447470b506c1f2ac780287eb
+  metadata.gz: 6045860e33279138a91d9f6fcdecc9dd589c448c9e576858f41969d3fe73fa79
+  data.tar.gz: 70ccce6b312cf4802261417393e724f6cfbc9d97aa7afd7a2d4783af148ba1ea
 SHA512:
-  metadata.gz: 53298e1df89dc374b4809a8c4b7602885dc911df397fd1271a2504c030649e059a3f876c499a0d0c358c56d16e7dc3d50183b36b06dfff6e4f41d0853497f76d
-  data.tar.gz: 2ce2cd48f28475c89d5305c0097031d19cfdbe11d3b0d8e9f16213fe1ef1b977324fe5a1996706b69b7204789270535f5cfac0254b015a9a7a8d0efd496c5ffa
+  metadata.gz: 7c0bbe35d45e9b099fcc6f1114b3e0cc8b0c8edc2cb1af04288c71a01e188bc1a4e88c68ccb905c30912d82082a822526f0721034b85c1b530b607341404e2d5
+  data.tar.gz: 7b2010fa445336f13a5067a436957e9899dd17af042ef816c7d742c36c2afd8dbad6c7d0a1a11d572e2f57212e06f100a51403bad0101a5ce9cb8e10505ac531

data/.github/workflows/ruby.yml

@@ -14,7 +14,7 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
-      uses: eregon/use-ruby-action@master
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
     - name: fix ImageMagick policy.xml on Linux

data/.rubocop.yml

@@ -58,6 +58,9 @@ Performance/StringReplacement:
 Performance/RangeInclude:
   Enabled: true
 
+Performance/DeletePrefix:
+  Enabled: false
+
 #### Style
 
 Style/AccessModifierDeclarations:
@@ -428,7 +431,7 @@ Metrics/BlockNesting:
   Max: 4
 
 Metrics/ModuleLength:
-  Max: 200
+  Max: 300
 
 Metrics/ParameterLists:
   Max: 8

data/NEWS.ja.md

@@ -1,3 +1,32 @@
+# Version 4.2.0
+## 新機能
+* 図・表・リスト・式のキャプションの位置を内容の上側・下側どちらにするかを指定する `caption_position` パラメータを追加しました。`caption_position` の下位パラメータとして `image`・`table`・`list`・`equation` のパラメータがあり、値として `top` (上側) または `bottom` (下側) を指定します。デフォルトは `image` のみ `bottom`、ほかは `top` です ([#1320])
+
+## 非互換の変更
+* review-vol を再構成しました。部の処理や見出し内のインライン命令の処理を正しました。表示形式をわかりやすい形に変更しました。部を指定したときに部のボリュームではなく、部ファイル単体のボリュームを返すようにしました。`-P`, `--directory` オプションは廃止しました ([#1485])
+* review-index を再構成しました。オプション名を大幅に変更しています。行数・文字数は `-d` オプションを指定したときのみ表示するようにしました。また、ファイルの行数・文字数ではなく、PLAINTEXTBuilder を利用して、変換結果に近い行数・文字数を返すようにしました (review-vol よりも正確です)。特定の章は `-y` オプションで複数指定できるようにしました ([#1485])
+
+## バグ修正
+* 重複する `@non_parsed_commands` 宣言を削除しました ([#1499])
+* WebMaker、TextMaker で数式画像が作成されない問題を修正しました ([#1501])
+
+## 機能強化
+* imgmath での数式画像の作成処理を最適化し、高速化しました ([#1488])
+* デフォルト以外の固有の YAML 設定を PDFMaker に引き渡したいときのために、`layouts/config-local.tex.erb` ファイルが存在すればそれを評価・読み込みするようにしました ([#1505])
+
+## その他
+* GitHub Actions を eregon/use-ruby-action から ruby/setup-ruby に切り替えました ([#1490])
+* テストの際、samples フォルダ内にあるビルド成果物を無視するようにしました ([#1504])
+
+[#1320]: https://github.com/kmuto/review/issues/1320
+[#1485]: https://github.com/kmuto/review/issues/1485
+[#1488]: https://github.com/kmuto/review/issues/1488
+[#1490]: https://github.com/kmuto/review/pull/1490
+[#1499]: https://github.com/kmuto/review/issues/1499
+[#1501]: https://github.com/kmuto/review/pull/1501
+[#1504]: https://github.com/kmuto/review/pull/1504
+[#1505]: https://github.com/kmuto/review/issues/1505
+
 # Version 4.1.0
 ## 新機能
 * 表のセル区切りの文字を `table_row_separator` パラメータで変更できるようにしました。指定可能な値は tabs (1個以上のタブ、デフォルト)、singletab (1文字のタブ文字区切り)、spaces (1文字以上のスペースまたはタブ文字の区切り)、 verticalbar ("0個以上の空白 | 0個以上の空白" の区切り) です ([#1420])

data/NEWS.md

@@ -1,3 +1,32 @@
+# Version 4.2.0
+## New Features
+* introduce `caption_position` parameter to specify a caption position of image, table, list, and equation. `caption_position` has child parameters `image`, `table`, `list`, and `equation` and the value is `top` or `bottom` ([#1320])
+
+## Breaking Changes
+* review-vol is rewritten.  Improved processing of parts and inline instructions in headings. Changed display format. When a part is specified, the volume of the part file itself is returned instead of the volume of the part. The `-P` and `--directory` options have been removed ([#1485])
+* review-index is rewritten. Most option names have been changed. The number of lines and characters are now displayed only when `-d` option is specified. review-index uses PLAINTEXTBuilder to return accurate line and character counts. `-y` option is provided to specify a target chapter ([#1485])
+
+## Bug Fixes
+* remove duplicated `@non_parsed_commands` declaration ([#1499])
+* mathematical images not being created in WebMaker and TextMaker has been fixed ([#1501])
+
+## Enhancements
+* improve a performance of building math figures on imgmath ([#1488])
+* for those times when you want to hand over non-default YAML parameters to PDFMaker, you can write your own `layouts/config-local.tex.erb` file ([#1505])
+
+## Others
+* GitHub Actions: use `ruby/setup-ruby` instead of `eregon/use-ruby-action` ([#1490])
+* skip artifacts in the sample folder during testing ([#1504])
+
+[#1320]: https://github.com/kmuto/review/issues/1320
+[#1485]: https://github.com/kmuto/review/issues/1485
+[#1488]: https://github.com/kmuto/review/issues/1488
+[#1490]: https://github.com/kmuto/review/pull/1490
+[#1499]: https://github.com/kmuto/review/issues/1499
+[#1501]: https://github.com/kmuto/review/pull/1501
+[#1504]: https://github.com/kmuto/review/pull/1504
+[#1505]: https://github.com/kmuto/review/issues/1505
+
 # Version 4.1.0
 ## New Features
 * add `table_row_separator` to specify a separator that separates table rows. Accceptable value: tabs (means `\t+`, default), `singletab` (means `\t`), spaces (means `\s+`), verticalbar (means `\s*\|\s*`) ([#1420])

data/bin/review-index

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 #
-# Copyright (c) 2008-2019 Minero Aoki, Kenshi Muto
+# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto
 #               1999-2007 Minero Aoki
 #
 # This program is free software.
@@ -14,93 +14,6 @@ require 'pathname'
 bindir = Pathname.new(__FILE__).realpath.dirname
 $LOAD_PATH.unshift((bindir + '../lib').realpath)
 
-require 'review/book'
-require 'review/tocparser'
 require 'review/tocprinter'
-require 'review/version'
-require 'optparse'
 
-def main
-  @logger = ReVIEW.logger
-  Signal.trap(:INT) { exit 1 }
-  if RUBY_PLATFORM !~ /mswin(?!ce)|mingw|cygwin|bccwin/
-    Signal.trap(:PIPE, 'IGNORE')
-  end
-  _main
-rescue Errno::EPIPE
-  exit 0
-end
-
-def _main
-  yamlfile = 'config.yml'
-  printer_class = ReVIEW::TextTOCPrinter
-  source = nil
-  upper = ReVIEW::TOCPrinter.default_upper_level
-  param = {}
-  book = ReVIEW::Book::Base.load
-
-  opts = OptionParser.new
-  opts.version = ReVIEW::VERSION
-  opts.on('--yaml=YAML', 'Read configurations from YAML file.') { |yaml| yamlfile = yaml }
-  opts.on('-a', '--all', 'print all chapters.') { source = book }
-  opts.on('-p', '--part N', 'list only part N.') do |n|
-    source = book.part(Integer(n)) or
-      error_exit("part #{n} does not exist in this book")
-  end
-  opts.on('-c', '--chapter C', 'list only chapter C.') do |c|
-    begin
-      source = ReVIEW::Book::Part.new(nil, 1, [book.chapter(c)])
-    rescue
-      error_exit("chapter #{c} does not exist in this book")
-    end
-  end
-  opts.on('-l', '--level N', 'list upto N level (1..4, default=4)') do |n|
-    upper = Integer(n)
-    unless (0..4).cover?(upper) # 0 is hidden option
-      $stderr.puts '-l/--level option accepts only 1..4'
-      exit 1
-    end
-  end
-  opts.on('--text', 'output in plain text (default)') { printer_class = ReVIEW::TextTOCPrinter }
-  opts.on('--html', 'output in HTML (deprecated)') { printer_class = ReVIEW::HTMLTOCPrinter }
-  opts.on('--help', 'print this message and quit.') do
-    puts opts.help
-    exit 0
-  end
-  begin
-    opts.parse!
-  rescue OptionParser::ParseError => e
-    @logger.error e.message
-    $stderr.puts opts.help
-    exit 1
-  end
-
-  book.config = ReVIEW::Configure.values
-  book.load_config(yamlfile) if yamlfile
-
-  if source
-    error_exit('-a/-s option and file arguments are exclusive') unless ARGV.empty?
-  else
-    puts opts.help
-    exit 0
-  end
-
-  begin
-    printer = printer_class.new(upper, param)
-    if source.is_a?(ReVIEW::Book::Part)
-      printer.print_part(source)
-    else
-      printer.print_book(source)
-    end
-  rescue ReVIEW::Error, Errno::ENOENT => e
-    raise if $DEBUG
-    error_exit(e.message)
-  end
-end
-
-def error_exit(msg)
-  @logger.error msg
-  exit 1
-end
-
-main
+ReVIEW::TOCPrinter.execute(*ARGV)

data/bin/review-vol

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 #
-# Copyright (c) 2014-2019 Minero Aoki, Kenshi Muto
+# Copyright (c) 2014-2020 Minero Aoki, Kenshi Muto
 #               2003-2014 Minero Aoki
 #
 # This program is free software.
@@ -14,82 +14,8 @@ require 'pathname'
 bindir = Pathname.new(__FILE__).realpath.dirname
 $LOAD_PATH.unshift((bindir + '../lib').realpath)
 
-require 'review'
-require 'optparse'
+require 'review/volumeprinter'
 
-include ReVIEW::TextUtils
-
-def main
-  @logger = ReVIEW.logger
-  @config = ReVIEW::Configure.values
-
-  part_sensitive = false
-  basedir = nil
-  yamlfile = 'config.yml'
-  opts = OptionParser.new
-  opts.version = ReVIEW::VERSION
-  opts.on('--yaml=YAML', 'Read configurations from YAML file.') { |yaml| yamlfile = yaml }
-  opts.on('-P', '--part-sensitive', 'Prints volume of each parts.') { part_sensitive = true }
-  opts.on('--directory=DIR', 'Compile all chapters in DIR.') { |path| basedir = path }
-  opts.on('--help', 'Print this message and quit') do
-    puts opts.help
-    exit 0
-  end
-  begin
-    opts.parse!
-  rescue OptionParser::ParseError => e
-    @logger.error e.message
-    $stderr.puts opts.help
-    exit 1
-  end
-
-  book = basedir ? ReVIEW::Book.load(basedir) : ReVIEW::Book::Base.load
-  book.config = @config
-  if yamlfile
-    book.load_config(yamlfile)
-  end
-
-  if part_sensitive
-    sep = ''
-    book.each_part do |part|
-      print sep
-      sep = "\n"
-      if part.number
-        puts "Part #{part.number} #{part.name}"
-      end
-      part.each_chapter do |chap|
-        print_chapter_volume chap
-      end
-      puts '    --------------------'
-      print_volume part.volume
-    end
-  else
-    book.each_chapter do |chap|
-      print_chapter_volume chap
-    end
-  end
-  puts '============================='
-  print_volume(book.volume) # puts "Total #{book.volume}"
-rescue ReVIEW::ApplicationError, Errno::ENOENT => e
-  raise if $DEBUG
-  @logger.error e.message
-  exit 1
-end
-
-def print_chapter_volume(chap)
-  vol = chap.volume
-  title = chap.title
-  printf("%s %3dKB %6dC %5dL %3dP %s %-s\n",
-         chapnumstr(chap.number), vol.kbytes, vol.chars, vol.lines, vol.page,
-         "#{chap.name} ".ljust(25, '.'), title)
+if File.basename($PROGRAM_NAME) == File.basename(__FILE__)
+  ReVIEW::VolumePrinter.execute(*ARGV)
 end
-
-def print_volume(vol)
-  printf("    %3dKB %6dC %5dL %3dP\n", vol.kbytes, vol.chars, vol.lines, vol.page)
-end
-
-def chapnumstr(n)
-  n ? sprintf('%2d.', n) : '   '
-end
-
-main

data/doc/config.yml.sample

@@ -74,7 +74,7 @@ aut: ["青木峰郎", "武藤健志", "高橋征義", "角征典"]
 # 日付の後ろを空白文字で区切り、任意の文字列を置くことも可能。
 # history: [["2016-04-20 v1.0.0版発行", "2018-11-11 v3.0.0版発行"]]
 # 権利表記(配列で複数指定可)
-# rights: (C) 2016-2019 Re:VIEW Developers
+# rights: (C) 2016-2020 Re:VIEW Developers
 # description: 説明
 # subject: 短い説明用タグ(配列で複数指定可)
 # type: 書籍のカテゴリーなど(配列で複数指定可)
@@ -184,13 +184,26 @@ toc: true
 # //table命令における列の区切り文字。tabs (1文字以上のタブ文字区切り。デフォルト), singletab (1文字のタブ文字区切り), spaces (1文字以上のスペースまたはタブ文字の区切り), verticalbar ("0個以上の空白 | 0個以上の空白"の区切り)
 # table_row_separator: tabs
 
-# review-vol向けのヒント情報
-# 1ページの行数文字数と1kbごとのページ数を用紙サイズで指定する(A5 or B5)
+# 複数行から段落を結合する際、前後のUnicode文字種に基づき必要に応じて空白文字を挿入するか
+# 省略した場合はnull (挿入しない)。別途unicode-eaw gemファイルが必要
+# join_lines_by_lang: null
+
+# 図・表・コードリスト・数式のキャプション位置。
+# 値はtop（上）またはbottom（下）でデフォルトは以下のとおり
+# caption_position:
+#   image: bottom
+#   table: top
+#   list: top
+#   equation: top
+
+# review-toc向けのヒント情報
+# (文字幅を考慮した行数計測には、別途unicode-eaw gemファイルが必要)
+# ページあたりの行数文字数を用紙サイズで指定する(A5 or B5)
 # page_metric: A5
 #
 # あるいは、配列で指定することもできる
-# 各数字の意味は、順にリストの行数、リストの1行字数、テキストの行数、テキストの1行字数、1kバイトごとのページ数
-# page_metric: [40,80,40,80,2]
+# 各数字の意味は、順にリストの行数、リストの1行字数、テキストの行数、テキストの1行字数
+# page_metric: [40,34,29,34]
 
 # EPUB・Web、およびテキスト生成時における数式の画像化指定
 # TeXの数式を画像化するか。省略した場合はnull (作成しない)

data/doc/config.yml.sample-simple

@@ -23,7 +23,7 @@ prt: "Re:VIEW Printing inc."
 contact: "https://reviewml.org/"
 date: 2018-11-11
 history: [["2012-01-30"],["2016-04-20","2016-05-03"],["2018-11-11"]]
-rights: (C) 2016-2019 Re:VIEW Commiters, some rights reserved.
+rights: (C) 2016-2020 Re:VIEW Commiters, some rights reserved.
 description: sample config.yml file for Re:VIEW book
 urnid: urn:uid:http://reviewml.org/review-sample-book
 # isbn: null

data/doc/pdfmaker.ja.md

@@ -109,6 +109,48 @@ Re:VIEW 3.0 から review-jlreq.cls という別のクラスファイルも用
 
 その他の詳細な設定については、sty フォルダにある README.md を参照してください。
 
+### カスタムパラメータの引き渡し
+
+技術的な都合で、config.yml の YAML 設定から TeX のマクロへの変換はすべての設定について行われるわけではなく、ごく限られた値のみに制限しています。これは Re:VIEW 内部の `config.erb` ( https://github.com/kmuto/review/blob/master/templates/latex/config.erb ) の ERB スクリプトによって処理されており、この挙動を変更することは許容していません。
+
+任意の YAML 設定を TeX に引き渡すには、`config.erb` と同様に YAML から TeX への変換を行う固有の ERB スクリプトを作成して配置します。このためには、プロジェクトフォルダに `layouts` フォルダを作成し、そこに固有の ERB スクリプトを `config-local.tex.erb` という名前で置きます。
+
+`config-local.tex.erb` は `config.erb` の評価・埋め込みの後、評価・埋め込みされます。
+
+config.yml を次のようにして、これを TeX に渡したいとします。
+
+```
+mycustom:
+  mystring: HELLO_#1
+  mybool: true
+```
+
+`layouts/config-local.tex.erb` はたとえば次のようになります。
+
+```
+\def\mystring{<%= escape(@config['mycustom']['mystring']) %>}
+<%- if @config['mycustom']['mybool'] -%>
+\def\mybool{true}
+<%- end -%>
+```
+
+次のように展開されます。
+```
+ …
+\makeatother
+%% BEGIN: config-local.tex.erb
+\def\mystring{HELLO\textunderscore{}\#1}
+\def\mybool{true}
+%% END: config-local.tex.erb
+
+\usepackage{reviewmacro}
+ …
+```
+
+こうして定義されたマクロを sty ファイルなどで参照します。
+
+なお、ERB での YAML 解析、および TeX マクロの記述において誤りがあると、極めてわかりにくいエラーになることがあります。`--debug` オプション付きで実行して展開された `__REVIEW_BOOK__.tex` を確認して原因を調査するのがよいでしょう。
+
 ## Re:VIEW 2.0 以前の情報
 
 ### upLaTeX について

data/doc/pdfmaker.md

@@ -84,6 +84,47 @@ Since Re:VIEW 3.0, review-jlreq.cls is also provided. This class file extends jl
 
 `review-init --latex-template=review-jlreq` command copies the review-jlreq.cls set to `sty` folder.
 
+### Handing over custom parameters
+
+For technical reasons, only a small part of the YAML parameters in config.yml is converted to TeX macros. Re:VIEW's internal `config.erb` ( https://github.com/ kmuto/review/blob/master/templates/latex/ config.erb ) ERB script manages this. You cannot change this script.
+
+If you want to give YAML parameters to TeX, you can use your own ERB script that do the YAML to TeX conversion. This is done by creating `layouts/config-local.tex.erb` in the project folder.
+
+After evaluation and embedding of `config.erb`, `config-local.tex. erb` will be evaluated and embedded as well. For example,
+
+`config.yml`:
+
+```
+mycustom:
+  mystring: HELLO_#1
+  mybool: true
+```
+
+`layouts/config-local.tex.erb`:
+
+```
+\def\mystring{<%= escape(@config['mycustom']['mystring']) %>}
+<%- if @config['mycustom']['mybool'] -%>
+\def\mybool{true}
+<%- end -%>
+```
+
+will be parsed:
+
+```
+ …
+\makeatother
+%% BEGIN: config-local.tex.erb
+\def\mystring{HELLO\textunderscore{}\#1}
+\def\mybool{true}
+%% END: config-local.tex.erb
+
+\usepackage{reviewmacro}
+ …
+```
+
+Refer to these macros in your sty file.
+
 ## Important Changes about LaTeX in Re:VIEW 2.0
 
 * Default LaTeX compiler is upLaTeX, not pLaTeX.