review 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e84bcc2665b217e208b209c794a7d4e4a71440f8094cb32e969e294ef49b525b
-  data.tar.gz: 5a27039b3a6fa44437786debfc54fa2fe24213fdb497a84d4a483bb590fd1118
+  metadata.gz: fd7268a71d883dbd67373a3a6c3d4d151b67cb01e6545bf83fc1b26ce9eaee02
+  data.tar.gz: 3214804b54cba60f961ceda0ee83f8f2d50080ba3bbd691cca179057bd8dc3ac
 SHA512:
-  metadata.gz: cadd2c9a936fd38bd84f15d9b06fd0e85cd1df1b32e8116e165f4dd67801cdef887ca0e1c788ed8d5c3cc3b9979d729eb886149b7c188d2d461f459d6da36923
-  data.tar.gz: ce5a14cc670d7c57ce8fb6b7c2a885dc9bdef074da06eaa3a83d1bca5eeaa4196d42f60763d86e0aa2afe8a2115ad38f3e6e43ef69aaedd930dd938eefb50bd5
+  metadata.gz: bc7ccb389d4c6d836adf683f53961646e126149a63c29cda14ecbc4b95b44745a856169326ab98e84d5189b8fca4bb08dbf7292089990231a1c22063ccf58557
+  data.tar.gz: 49790ebe6d85e685b1e9fbc0f1bc635a050ca844c8dd34369e79dee8972884c5bb1f2f9cce194ce7c7947d303503b4ba549741ab1f8069a924309b6696934701

data/.rubocop.yml

@@ -5,6 +5,9 @@ AllCops:
     - test/syntax-book/*
   DisplayCopNames: true
 
+require:
+  - rubocop-performance
+
 inherit_from: .rubocop_todo.yml
 
 #### Lint
@@ -90,6 +93,9 @@ Style/ClassMethods:
 Style/CommentedKeyword:
   Enabled: false
 
+Style/FloatDivision:
+  Enabled: false
+
 # Do not introduce global variables.
 Style/GlobalVars:
   Enabled: true
@@ -331,7 +337,7 @@ Layout/IndentationConsistency:
 Layout/IndentationWidth:
   Enabled: true
 
-Layout/IndentHash:
+Layout/IndentFirstHashElement:
   Enabled: true
 
 Layout/IndentHeredoc:
@@ -384,6 +390,10 @@ Layout/SpaceInsideStringInterpolation:
 Layout/TrailingBlankLines:
   Enabled: true
 
+Layout/TrailingWhitespace:
+  Enabled: true
+  AllowInHeredoc: true
+
 #### Metrics
 
 Metrics/BlockNesting:

data/.travis.yml

@@ -2,6 +2,10 @@ language: ruby
 sudo: false
 dist: trusty
 
+os:
+  - linux
+  - osx
+
 addons:
   apt:
     packages:
@@ -12,23 +16,20 @@ addons:
 
 before_install:
   - |-
-    RUBY_VER=`ruby -e "print RUBY_VERSION"`
-    if [ "$RUBY_VER" = "2.1.10" ]; then
-      gem install bundler -v '< 2'
-    elif [ "$RUBY_VER" = "2.2.10" ]; then
-      gem install bundler -v '< 2'
-    else
-      gem update --system
-      gem install bundler
-    fi
+    gem update --system
+    gem install bundler
+    gem install epubcheck-ruby
+
+script:
+  - bundle exec rake
+  - ruby bin/review-init hello && cd hello && ruby ../bin/review-epubmaker config.yml && epubcheck book.epub
+  - cd ..
+  - ruby bin/review-init hello2 --epub-version 2 && cd hello2 && ruby ../bin/review-epubmaker config.yml && epubcheck book.epub
 
 rvm:
-  - 2.1
-  - 2.2.10
-  - 2.3.8
-  - 2.4.5
-  - 2.5.3
-  - 2.6.0
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
 ##  - ruby-head
 
 branches:

data/NEWS.ja.md

@@ -1,3 +1,78 @@
+# Version 3.2.0
+
+## 新機能
+## 非互換の変更
+* PDFMaker: `//image` 命令などで画像を配置するときに `\includegraphics` ではなく、それを抽象化した `\reviewincludegraphics` を使うようにしました ([#1318])
+
+## バグ修正
+* 別の章の図表やリストを参照する際に章が存在しないとき、内部エラーではなく標準のキーエラーを返すようにしました ([#1284])
+* review-compile のエラーメッセージで提示する値の誤りを修正しました ([#1286])
+* PDFMaker: review-jsbook において、serial_pagination=true を設定しているとき、PDF のページ番号のメタ情報がおかしくなるのを修正しました ([#1288])
+* notoc, nodisp, nonum を含む見出しを `@<hd>` で参照したときに番号が付いてしまうこと、およびその後の見出しの番号がおかしくなることを修正しました ([#1294])
+* PDFMaker: jlreq.cls 0401 版利用時に review-jlreq.cls でエラーが出るのを修正しました ([#1298])
+* EPUBMaker: EPUB2 の生成に失敗するのを修正しました ([#1301])
+* EPUBMaker: Windows で一時フォルダの削除にときどき失敗する現象に対処しました ([#1011])
+* PDFMaker: `@<bou>` をサポートしました ([#1220])
+* PDFMaker: jlreq.cls の古いバージョンでも動くように対処しました ([#1317])
+
+## 機能強化
+* `CHAPS:` が空のときのテストを追加しました ([#1275])
+* PDFMaker: 安全のため、reviewtt などのインライン書体命令を RobustCommand マクロで定義するようにしました ([#1280])
+* EPUBMaker: デバッグモードで実行する `--debug` オプションを追加しました ([#1281])
+* review-epub2html: 脚注をインラインで表現する `--inline-footnote` オプションを追加しました ([#1283])
+* EPUBMaker: iBooks 向けに、EPUB3 においても表紙画像のメタデータを入れるようにしました ([#1293])
+* PDFMaker: review-jsbook および review-jlreq において、コードリストや数式のキャプションの直後に改ページされる現象を程度抑制するようにしました ([#1299])
+* rubocop 0.67.2 に基づいてコードを整形しました ([#1297])
+* EPUB 作成のテストを追加しました ([#1300])
+* テスト対象の Ruby バージョンを 2.4.6, 2.5.5, 2.6.3 としました ([#1303])
+* YAMLLoader のコードを改良しました ([#1304])
+* `*` の箇条書きで、`**` から始めたり、`*` のあとに `***` を使ったりといった不正なレベル指定をエラーにしました ([#1313])
+* ReVIEW::Location クラスを分離しました ([#1308])
+* 箇条書きや文献リストで複数行の英単語が連結されてしまうのを回避しました (ただし PDFMaker のみ) ([#1312])
+* 空の表があったときにエラーを出すようにしました ([#1325])
+* いくつかのテスト対象を追加しました ([#1327], [#1328])
+* MARKDOWNBuilder: ``//listnum``に対応しました ([#1336])
+
+## ドキュメント
+* 見出しのレベルの説明の誤りを修正しました ([#1309])
+
+## その他
+* もう使われていない ReVIEW::Preprocessor::Strip を削除しました ([#1305])
+
+## コントリビューターのみなさん
+* [@uetchy](https://github.com/uetchy)
+* [@mitsuo0114](https://github.com/mitsuo0114)
+
+[#1011]: https://github.com/kmuto/review/issues/1011
+[#1220]: https://github.com/kmuto/review/issues/1220
+[#1275]: https://github.com/kmuto/review/pull/1275
+[#1280]: https://github.com/kmuto/review/pull/1280
+[#1281]: https://github.com/kmuto/review/issues/1281
+[#1283]: https://github.com/kmuto/review/pull/1283
+[#1284]: https://github.com/kmuto/review/issues/1284
+[#1286]: https://github.com/kmuto/review/pull/1286
+[#1288]: https://github.com/kmuto/review/issues/1288
+[#1293]: https://github.com/kmuto/review/pull/1293
+[#1294]: https://github.com/kmuto/review/issues/1294
+[#1297]: https://github.com/kmuto/review/pull/1297
+[#1298]: https://github.com/kmuto/review/pull/1298
+[#1299]: https://github.com/kmuto/review/pull/1299
+[#1300]: https://github.com/kmuto/review/pull/1300
+[#1301]: https://github.com/kmuto/review/pull/1301
+[#1303]: https://github.com/kmuto/review/pull/1303
+[#1304]: https://github.com/kmuto/review/pull/1304
+[#1305]: https://github.com/kmuto/review/pull/1305
+[#1308]: https://github.com/kmuto/review/pull/1308
+[#1309]: https://github.com/kmuto/review/issues/1309
+[#1312]: https://github.com/kmuto/review/issues/1312
+[#1313]: https://github.com/kmuto/review/issues/1313
+[#1317]: https://github.com/kmuto/review/pull/1317
+[#1318]: https://github.com/kmuto/review/issues/1318
+[#1325]: https://github.com/kmuto/review/issues/1325
+[#1327]: https://github.com/kmuto/review/issues/1327
+[#1328]: https://github.com/kmuto/review/pull/1328
+[#1336]: https://github.com/kmuto/review/pull/1336
+
 # Version 3.1.0
 
 ## 非互換の変更

data/NEWS.md

@@ -1,3 +1,78 @@
+# Version 3.2.0
+
+## New Features
+## Breaking Changes
+* PDFMaker: changed to use the abstract name `\reviewincludegraphics` instead of `\includegraphics` for image placements (such as `//image`) ([#1318])
+
+## Bug Fixes
+* reference to IDs of non-existent chapter now return standard key error (instead of internal error) ([#1284])
+* fixed the value in the error message of review-compile ([#1286])
+* PDFMaker: fixed the metadata of PDF page number was wrong when using review-jsbook with serial_pagination = true ([#1288])
+* fixed a bug when using `@<hd>` to refer to headings with notoc, nodisp, or nonum ([#1294])
+* PDFMaker: fixed an error in review-jlreq when using jlreq.cls version 0401 ([#1298])
+* EPUBMaker: fixed a error of building EPUB2 ([#1301])
+* EPUBMaker: added a workaround for a temporary folder deletion failure on Windows ([#1011])
+* PDFMaker: support `@<bou>` ([#1220])
+* PDFMaker: support old jlreq.cls ([#1317])
+
+## Enhancements
+* added test when `CHAPS:` is empty ([#1275])
+* PDFMaker: for safety, inline typeface commands such as `\reviewtt` are defined with RobustCommand ([#1280])
+* EPUBMaker: added `--debug` option to execute in debug mode ([#1281])
+* review-epub2html: added `--inline-footnote` option to represent footnotes as inline ([#1283])
+* EPUBMaker: added metadata of the cover image on EPUB3 for iBooks ([#1293])
+* PDFMaker: suppressed the unexptected page break after the caption of code list or equation in review-jsbook and review-jlreq ([#1299])
+* reformatted the codes using rubocop 0.67.2 ([#1297])
+* added a test of building EPUB ([#1300])
+* updated Ruby versions of test target to 2.4.6, 2.5.5, and 2.6.3 ([#1303])
+* improved the code of YAMLLoader ([#1304])
+* raise an error when invalid level is used in bullet ([#1313])
+* extracted ReVIEW::Location class ([#1308])
+* avoid multi-lined English words being combined without a space in bullets and bibliographic list (only in PDFMaker, at this time) ([#1312])
+* raise an error when table is empty ([#1325])
+* add some tests ([#1327], [#1328])
+* MARKDOWNBilder: support `//listnum` ([#1336])
+
+## Docs
+* fixed the description about header levels ([#1309])
+
+## Others
+* removed ReVIEW::Preprocessor::Strip due to it is no longer used ([#1305])
+
+## Contributors
+* [@uetchy](https://github.com/uetchy)
+* [@mitsuo0114](https://github.com/mitsuo0114)
+
+[#1011]: https://github.com/kmuto/review/issues/1011
+[#1220]: https://github.com/kmuto/review/issues/1220
+[#1275]: https://github.com/kmuto/review/pull/1275
+[#1280]: https://github.com/kmuto/review/pull/1280
+[#1281]: https://github.com/kmuto/review/issues/1281
+[#1283]: https://github.com/kmuto/review/pull/1283
+[#1284]: https://github.com/kmuto/review/issues/1284
+[#1286]: https://github.com/kmuto/review/pull/1286
+[#1288]: https://github.com/kmuto/review/issues/1288
+[#1293]: https://github.com/kmuto/review/pull/1293
+[#1294]: https://github.com/kmuto/review/issues/1294
+[#1297]: https://github.com/kmuto/review/pull/1297
+[#1298]: https://github.com/kmuto/review/pull/1298
+[#1299]: https://github.com/kmuto/review/pull/1299
+[#1300]: https://github.com/kmuto/review/pull/1300
+[#1301]: https://github.com/kmuto/review/pull/1301
+[#1303]: https://github.com/kmuto/review/pull/1303
+[#1304]: https://github.com/kmuto/review/pull/1304
+[#1305]: https://github.com/kmuto/review/pull/1305
+[#1308]: https://github.com/kmuto/review/pull/1308
+[#1309]: https://github.com/kmuto/review/issues/1309
+[#1312]: https://github.com/kmuto/review/issues/1312
+[#1313]: https://github.com/kmuto/review/issues/1313
+[#1317]: https://github.com/kmuto/review/pull/1317
+[#1318]: https://github.com/kmuto/review/issues/1318
+[#1325]: https://github.com/kmuto/review/issues/1325
+[#1327]: https://github.com/kmuto/review/issues/1327
+[#1328]: https://github.com/kmuto/review/pull/1328
+[#1336]: https://github.com/kmuto/review/pull/1336
+
 # Version 3.1.0
 ## Breaking Changes
 * PDFMaker: introduce `\reviewimagecaption` macro for the caption of figure ([#1254]). Please update your review-base.sty by `review-update` command on your  Re:VIEW 3 project.

data/appveyor.yml

@@ -8,11 +8,29 @@ build_script:
   - bundle exec rake test --trace --verbose
   - bundle exec rubocop
 
+before_test:
+  - gem install -N epubcheck-ruby
+
+test_script:
+  - ruby bin/review-init hello
+  - cd hello
+  - ruby ../bin/review-epubmaker config.yml
+  - epubcheck book.epub
+  - cd ..
+  - ruby bin/review-init hello2 --epub-version 2
+  - cd hello2
+  - ruby ../bin/review-epubmaker config.yml
+  - epubcheck book.epub
+
 branches:
   only:
     - master
 
 environment:
   matrix:
-    - ruby_version: "23"
-    - ruby_version: "23-x64"
+    - ruby_version: "24"
+    - ruby_version: "24-x64"
+    - ruby_version: "25"
+    - ruby_version: "25-x64"
+    - ruby_version: "26"
+    - ruby_version: "26-x64"

data/bin/review-catalog-converter

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 #
-# Copyright (c) 2014-2017 Masanori Kado, Kenshi Muto
+# Copyright (c) 2014-2019 Masanori Kado, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -30,8 +30,8 @@ def main
 
   begin
     opts.parse!
-  rescue OptionParser::ParseError => err
-    @logger.error err.message
+  rescue OptionParser::ParseError => e
+    @logger.error e.message
     $stderr.puts opts.help
     exit 1
   end

data/bin/review-check

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 #
-# Copyright (c) 2010-2017 Kenshi Muto, Minero Aoki
+# Copyright (c) 2010-2019 Kenshi Muto, Minero Aoki
 #               1999-2007 Minero Aoki
 #
 # This program is free software.
@@ -58,8 +58,8 @@ def main
   end
   begin
     opts.parse!
-  rescue OptionParser::ParseError => err
-    @logger.error(err.message)
+  rescue OptionParser::ParseError => e
+    @logger.error(e.message)
     puts opts.help
     exit 1
   end

data/bin/review-compile

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 #
-# Copyright (c) 2008-2018 Kenshi Muto, Masayoshi Takahashi, KADO Masanori, Minero Aoki
+# Copyright (c) 2008-2019 Kenshi Muto, Masayoshi Takahashi, KADO Masanori, Minero Aoki
 # Copyright (c) 1999-2007 Minero Aoki
 #
 # This program is free software.
@@ -50,7 +50,7 @@ def _main
   begin
     loader = ReVIEW::YAMLLoader.new
     if @config['yaml']
-      error "#{config['yaml']} not found." unless File.exist?(@config['yaml'])
+      error "#{@config['yaml']} not found." unless File.exist?(@config['yaml'])
       begin
         @config.deep_merge!(loader.load_file(@config['yaml']))
       rescue => e
@@ -109,8 +109,8 @@ def _main
     else
       raise "must not happen: #{@mode}"
     end
-  rescue ReVIEW::ApplicationError => err
-    error(err.message)
+  rescue ReVIEW::ApplicationError => e
+    error(e.message)
   end
 end
 
@@ -162,8 +162,8 @@ def parse_opts
         raise OptionParser::ParseError, 'no target given'
       end
     end
-  rescue OptionParser::ParseError => err
-    warn(err.message)
+  rescue OptionParser::ParseError => e
+    warn(e.message)
     $stderr.puts opts.help
     exit 1
   end

data/bin/review-epubmaker

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-# Copyright (c) 2010-2017 Kenshi Muto and Masayoshi Takahashi
+# Copyright (c) 2010-2019 Kenshi Muto and Masayoshi Takahashi
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -10,39 +10,7 @@ require 'pathname'
 require 'optparse'
 bindir = Pathname.new(__FILE__).realpath.dirname
 $LOAD_PATH.unshift((bindir + '../lib').realpath)
-require 'review/epubmaker'
-require 'review/version'
-
-@logger = ReVIEW.logger
-
-rv = ReVIEW::EPUBMaker.new
-
-opts = OptionParser.new
-opts.version = ReVIEW::VERSION
-opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} [options] YAML_filename [export_filename]"
-opts.on('--help', 'Prints this message and quit.') do
-  puts opts.help
-  exit 0
-end
 
-begin
-  opts.parse!
-rescue OptionParser::ParseError => err
-  @logger.error err.message
-  $stderr.puts opts.help
-  exit 1
-end
-
-if ARGV.size < 1
-  puts opts.help
-  exit 1
-end
-
-unless File.exist?(ARGV[0])
-  @logger.error "#{File.basename($PROGRAM_NAME, '.*')}: #{ARGV[0]} not found."
-  exit 1
-end
+require 'review/epubmaker'
 
-yaml_file = ARGV[0]
-bookname = ARGV[1]
-rv.produce(yaml_file, bookname)
+ReVIEW::EPUBMaker.execute(*ARGV)

data/bin/review-index

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 #
-# Copyright (c) 2008-2017 Minero Aoki, Kenshi Muto
+# Copyright (c) 2008-2019 Minero Aoki, Kenshi Muto
 #               1999-2007 Minero Aoki
 #
 # This program is free software.
@@ -69,8 +69,8 @@ def _main
   end
   begin
     opts.parse!
-  rescue OptionParser::ParseError => err
-    @logger.error err.message
+  rescue OptionParser::ParseError => e
+    @logger.error e.message
     $stderr.puts opts.help
     exit 1
   end
@@ -92,9 +92,9 @@ def _main
     else
       printer.print_book source
     end
-  rescue ReVIEW::Error, Errno::ENOENT => err
+  rescue ReVIEW::Error, Errno::ENOENT => e
     raise if $DEBUG
-    error_exit err.message
+    error_exit e.message
   end
 end
 

data/bin/review-preproc

@@ -59,8 +59,8 @@ def main
   end
   begin
     opts.parse!
-  rescue OptionParser::ParseError => err
-    @logger.error err.message
+  rescue OptionParser::ParseError => e
+    @logger.error e.message
     $stderr.puts opts.help
     exit 1
   end
@@ -91,9 +91,9 @@ def main
       raise "must not happen: #{mode}"
     end
   end
-rescue ReVIEW::Error => err
+rescue ReVIEW::Error => e
   raise if $DEBUG
-  @logger.error err.message
+  @logger.error e.message
   exit 1
 end