review 4.2.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6045860e33279138a91d9f6fcdecc9dd589c448c9e576858f41969d3fe73fa79
-  data.tar.gz: 70ccce6b312cf4802261417393e724f6cfbc9d97aa7afd7a2d4783af148ba1ea
+  metadata.gz: a64963e856714bc3b342e5b436d5a78f310785cfcad7216afa8a1676ea8b22b1
+  data.tar.gz: a43be15aee421f6e864d7ba2007981717786ee359bb70d358cb9e4794827a47c
 SHA512:
-  metadata.gz: 7c0bbe35d45e9b099fcc6f1114b3e0cc8b0c8edc2cb1af04288c71a01e188bc1a4e88c68ccb905c30912d82082a822526f0721034b85c1b530b607341404e2d5
-  data.tar.gz: 7b2010fa445336f13a5067a436957e9899dd17af042ef816c7d742c36c2afd8dbad6c7d0a1a11d572e2f57212e06f100a51403bad0101a5ce9cb8e10505ac531
+  metadata.gz: 12d7b001415a9e5f1b38f652ec4b3e89d8ad55661eb20fd911e0e626e1f8b3651844816ed209fa6f015524dcf2ff6f2c604ad5427ebbed91d21187e62f8629d5
+  data.tar.gz: 95a137a10cf78f204a3ee1d94d078f4ebe24b9b5a710c43cd41fee30d04c40ce9d350d121cd76952df5a2f01bcb9166588e287399a71cd308ff4bae31cae128e

data/.github/workflows/ruby-win.yml

@@ -23,17 +23,23 @@ jobs:
         gem install bundler --no-document
         bundle install --retry 3
         bundle exec ruby test/run_test.rb --max-diff-target-string-size=10000 --verbose=v
-    - name: Test with epubcheck-ruby
+    - name: install Re:VIEW and epubcheck-ruby
       shell: bash
       run: |
         gem install -N epubcheck-ruby
-        ruby bin/review-init hello
+        rake install
+    - name: Test with epubcheck-ruby
+      shell: bash
+      run: |
+        review-init hello
         cd hello
-        ruby ../bin/review-epubmaker config.yml
+        ruby -e 'Dir.glob("*.re"){|path| File.write(path, File.read(path).gsub("=", "= foo")) }'
+        review-epubmaker config.yml
         epubcheck book.epub
         cd ..
-        ruby bin/review-init hello2 --epub-version 2
+        review-init hello2 --epub-version 2
         cd hello2
-        ruby ../bin/review-epubmaker config.yml
+        ruby -e 'Dir.glob("*.re"){|path| File.write(path, File.read(path).gsub("=", "= foo")) }'
+        review-epubmaker config.yml
         epubcheck book.epub
         cd ..

data/.rubocop.yml

@@ -3,13 +3,13 @@ AllCops:
     - lib/lineinput.rb
     - lib/uuid.rb
     - test/syntax-book/*
+    - tmp/*
   DisplayCopNames: true
+  NewCops: enable
 
 require:
   - rubocop-performance
 
-inherit_from: .rubocop_todo.yml
-
 #### Lint
 
 Lint/EmptyWhen:
@@ -25,9 +25,6 @@ Lint/AssignmentInCondition:
 Lint/ParenthesesAsGroupedExpression:
   Enabled: true
 
-#Lint/RescueWithoutErrorClass:
-#  Enabled: false
-
 Lint/UnderscorePrefixedVariableName:
   Enabled: true
 
@@ -43,6 +40,18 @@ Lint/UselessAssignment:
 Lint/ErbNewArguments:
   Enabled: false
 
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
 #### Performance
 
 Performance/RegexpMatch:
@@ -61,6 +70,36 @@ Performance/RangeInclude:
 Performance/DeletePrefix:
   Enabled: false
 
+Performance/RedundantMerge:
+  Enabled: true
+
+Performance/AncestorsInclude:
+  Enabled: true
+
+Performance/BigDecimalWithNumericArgument:
+  Enabled: true
+
+Performance/RedundantSortBlock:
+  Enabled: true
+
+Performance/RedundantStringChars:
+  Enabled: true
+
+Performance/ReverseFirst:
+  Enabled: true
+
+Performance/SortReverse:
+  Enabled: true
+
+Performance/Squeeze:
+  Enabled: true
+
+Performance/StringInclude:
+  Enabled: false
+
+Performance/CollectionLiteralInLoop:
+  Enabled: false
+
 #### Style
 
 Style/AccessModifierDeclarations:
@@ -75,7 +114,7 @@ Style/Alias:
   Enabled: true
 
 Style/AndOr:
-  Enabled: false
+  Enabled: true
 
 Style/BarePercentLiterals:
   EnforcedStyle: percent_q
@@ -84,9 +123,6 @@ Style/BarePercentLiterals:
 Style/BlockDelimiters:
   Enabled: true
 
-Style/BracesAroundHashParameters:
-  Enabled: false
-
 Style/CaseEquality:
   Enabled: false
 
@@ -123,7 +159,7 @@ Style/EmptyElse:
   Enabled: true
 
 Style/EvalWithLocation:
-  Enabled: false
+  Enabled: true
 
 Style/FormatString:
   EnforcedStyle: sprintf
@@ -144,13 +180,10 @@ Style/IfUnlessModifier:
 Style/MutableConstant:
   Enabled: false
 
-#Style/MultipleComparison:
-#  Enabled: true
-
-Style/RedundantInterpolation:
+Style/MultipleComparison:
   Enabled: true
 
-Performance/RedundantMerge:
+Style/RedundantInterpolation:
   Enabled: true
 
 Style/ZeroLengthPredicate:
@@ -219,6 +252,9 @@ Style/MethodCallWithArgsParentheses:
     - 'source'
     - 'assert'
     - 'assert_equal'
+    - 'assert_raise'
+    - 'assert_raises'
+    - 'assert_nothing_raised'
     - 'sh'
     - 'mv'
     - 'rm_rf'
@@ -313,8 +349,50 @@ Style/RedundantPercentQ:
 Style/WhileUntilModifier:
   Enabled: false
 
-#Style/YodaCondition:
-#  Enabled: true
+Style/YodaCondition:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: false
+
+Style/AccessorGrouping:
+  Enabled: false
+
+Style/CaseLikeIf:
+  Enabled: false
+
+Style/StringConcatenation:
+  Enabled: false
+
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+Style/SoleNestedConditional:
+  Enabled: false
+
+Style/CombinableLoops:
+  Enabled: false
 
 ### Layout
 
@@ -425,6 +503,17 @@ Layout/TrailingWhitespace:
   Enabled: true
   AllowInHeredoc: true
 
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Layout/LineLength:
+  Max: 256
+  Exclude:
+    - "test/**/*"
+
 #### Metrics
 
 Metrics/BlockNesting:
@@ -444,11 +533,6 @@ Metrics/ClassLength:
   Exclude:
     - 'test/*.rb'
 
-Metrics/LineLength:
-  Max: 256
-  Exclude:
-    - "test/**/*"
-
 ### should be < 50
 Metrics/MethodLength:
   Max: 100
@@ -483,8 +567,8 @@ Naming/AccessorMethodName:
   Enabled: true
 
 # When defining the == operator, name its argument other.
-#Style/BinaryOperatorParameterName:
-#  Enabled: true
+Naming/BinaryOperatorParameterName:
+  Enabled: true
 
 Naming/FileName:
   Enabled: false
@@ -513,3 +597,8 @@ Naming/VariableNumber:
 
 Security/YAMLLoad:
   Enabled: true
+
+#### Gemspec
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/NEWS.ja.md

@@ -1,3 +1,97 @@
+# Version 5.0.0
+## 新機能
+* review-jsbook / review-jlreq クラスに、`cover_fit_page` オプションを追加しました。`texdocumentclass` パラメータに `cover_fit_page=true` を付けると、画像サイズがどのようなものであっても仕上がりサイズに拡縮して表紙に貼り込みます。なお、制作において図版は実寸で作成することを推奨します ([#1534])
+* 小さな囲み要素 (`//note`, `//memo`, `//tip`, `//info`, `//warning`, `//important`, `//caution`, `//notice`) の中で、`//image` などのブロック命令を含めたり、および箇条書きを入れたりできるようになりました。拡張で類似のことを利用したいときには、defminicolumn で定義します ([#1558], [#1562])
+* 箇条書きの入れ子を指示する命令として `//beginchild`, `//endchild` という1行命令を追加しました。箇条書きの子にしたいものを `//beginchild` と `//endchild` で囲むと、前に位置する箇条書きの子要素になります。**この機能は実験的です。今後のバージョンで挙動を変えたり廃止したりする可能性があります** ([#1497])
+
+## 非互換の変更
+* review-jlreq.cls における hiddenfolio の配置を、jlreqtrimmarkssetup を使って実装するように変更しました。以前のバージョンとは位置や表示に若干の違いがあります ([#1397])
+* `chapterlink` パラメータのデフォルト値を true (有効) にしました。これが有効になっているときには、Web、EPUB での章・項の参照や、図表・リスト・式・参考文献の参照などがハイパーリンク化されます。TeX PDF においては `media=ebook` のときのみ、章・項・参考文献の参照がハイパーリンク化されます ([#1529])
+
+## バグ修正
+* PDFMaker: 同名で拡張子違いの図版ファイルがあるときに、位置がずれる問題を修正しました。extractbb コマンドは明示的に呼び出されなくなります ([#1483])
+* PDFMaker: 著者名 (`aut`) パラメータが空のときにエラーになる問題を修正しました ([#1517])
+* PDFMaker: `//indepimage` 命令で画像が存在せず、かつ ID に TeX のエスケープ対象となる文字を含んでいるとエラーが起きる問題を修正しました ([#1527])
+* PDFMaker: `bookttilename` や `aut` パラメータに TeX のエスケープ対象となる文字を入れると PDF メタ情報がおかしくなる問題を修正しました (`media=ebook` のときのみ) ([#1533])
+* WebMaker: HTML テンプレートで nil が入ってしまうのを修正しました ([#1545])
+* PDFMaker: 章番号を非表示にするとエラーで失敗するのを修正しました ([#1559])
+* MarkdownBuilder: note 等の中の段落を改行区切りではなく空行区切りにしました ([#1572])
+
+## 機能強化
+* 図表などのアイテムでエラーが発生したときの表示を詳細にしました ([#1523])
+* PDFMaker: `@<hd>` 命令で展開した項・段について、`media=ebook` のときにはハイパーリンクになるようにしました ([#1530])
+* HTMLBuilder および IDGXMLBuilder において、文字列のエスケープを従来の `cgi/util` の代わりにより高速な `cgi/escape` が利用できるときにはそれを利用するようにしました。また、`ReVIEW::HTMLUtils.escape` も書き換えられました ([#1536])
+* `@<icon>` 命令の利用時に ID の重複の警告が出るのを抑制しました ([#1541])
+* 不正なエンコーディングのファイルを受け取ったときに妥当なエラー表示をするようにしました ([#1544])
+* IndexBuilder を導入しました。これまで図表等の番号の管理および参照はその都度対象ファイルを解析する方法でしたが、IndexBuilder はプロジェクト全体を走査し、以降の各ビルダのために番号を提供します。review-ext.rb でブロック命令やインライン命令を追加していた場合、IndexBuilder クラス (またはその基底クラスである Builder クラス) にも追加が必要です ([#1384], [#1552])
+* ID やラベルに以下の文字または空白文字が含まれていると、TeX のコンパイルあるいは生成される EPUB においてエラーが発生するため、これらの文字が含まれているときには警告を出すようにしました ([#1393], [#1574])
+```
+#%\{}[]~/$'"|*?&<>`
+```
+
+## ドキュメント
+* format.ja.md と format.md のタイプミスを修正しました ([#1528])
+* makeindex.ja.md のサンプル結果の誤りを修正しました ([#1584])
+
+## その他
+* Rubocop 0.92.0 に対応しました ([#1511], [#1569], [#1573])
+* `Re:VIEW::Compiler` 内の `@strategy` は実際はビルダなので、`@builder` という名前に変更しました ([#1520])
+* Rubocop-performance 1.7.1 に対応しました ([#1521])
+* syntax-book サンプルドキュメントの Gemfile を更新しました ([#1522])
+* ImageMagick における GhostScript の呼び出しが非推奨となったため、テストを除去しました ([#1526])
+* 一部のテストユニットの不要な標準エラー出力を抑制しました ([#1538])
+* `Compilable` モジュールの代わりに、`Chapter` および `Part` のスーパークラスとなる `BookUnit` 抽象クラスを導入しました ([#1543])
+* `ReVIEW::Book::Base.load` をやめ、`ReVIEW::Book::Base.load` または `ReVIEW::Book::Base.new` を使うようにしました。`ReVIEW::Book::Base.load` に `:config` オプションを加えました ([#1548], [#1563])
+* 内部のパラメータの汎用構成のために `ReVIEW::Configure.create` コンストラクタを導入しました ([#1549])
+* WebMaker: 使われていない `clean_mathdir` メソッドを削除しました ([#1550])
+* catalog.yml の解析を `ReVIEW::Book::Base.new` の中で最初に実行するようにしました ([#1551])
+* ファイルの書き出しで可能なところは `File.write` を使うようにしました ([#1560])
+* Builder クラスの `builder_init` メソッドを削除し、`initialize` を使うようにしました ([#1564])
+
+## コントリビューターのみなさん
+* [@snoozer05](https://github.com/snoozer05)
+
+[#1384]: https://github.com/kmuto/review/pull/1384
+[#1393]: https://github.com/kmuto/review/issues/1393
+[#1397]: https://github.com/kmuto/review/issues/1397
+[#1483]: https://github.com/kmuto/review/issues/1483
+[#1497]: https://github.com/kmuto/review/pull/1497
+[#1511]: https://github.com/kmuto/review/pull/1511
+[#1517]: https://github.com/kmuto/review/issues/1517
+[#1520]: https://github.com/kmuto/review/pull/1520
+[#1521]: https://github.com/kmuto/review/pull/1521
+[#1522]: https://github.com/kmuto/review/pull/1522
+[#1523]: https://github.com/kmuto/review/pull/1523
+[#1526]: https://github.com/kmuto/review/pull/1526
+[#1527]: https://github.com/kmuto/review/pull/1527
+[#1528]: https://github.com/kmuto/review/pull/1528
+[#1529]: https://github.com/kmuto/review/issues/1529
+[#1530]: https://github.com/kmuto/review/issues/1530
+[#1533]: https://github.com/kmuto/review/issues/1533
+[#1534]: https://github.com/kmuto/review/issues/1534
+[#1536]: https://github.com/kmuto/review/pull/1536
+[#1538]: https://github.com/kmuto/review/pull/1538
+[#1541]: https://github.com/kmuto/review/pull/1541
+[#1543]: https://github.com/kmuto/review/pull/1543
+[#1544]: https://github.com/kmuto/review/issues/1544
+[#1545]: https://github.com/kmuto/review/issues/1545
+[#1548]: https://github.com/kmuto/review/pull/1548
+[#1549]: https://github.com/kmuto/review/pull/1549
+[#1550]: https://github.com/kmuto/review/pull/1550
+[#1551]: https://github.com/kmuto/review/pull/1551
+[#1552]: https://github.com/kmuto/review/pull/1552
+[#1558]: https://github.com/kmuto/review/pull/1558
+[#1559]: https://github.com/kmuto/review/issues/1559
+[#1560]: https://github.com/kmuto/review/pull/1560
+[#1562]: https://github.com/kmuto/review/pull/1562
+[#1563]: https://github.com/kmuto/review/pull/1563
+[#1564]: https://github.com/kmuto/review/pull/1564
+[#1569]: https://github.com/kmuto/review/pull/1569
+[#1572]: https://github.com/kmuto/review/pull/1572
+[#1573]: https://github.com/kmuto/review/pull/1573
+[#1574]: https://github.com/kmuto/review/issues/1574
+[#1584]: https://github.com/kmuto/review/pull/1584
+
 # Version 4.2.0
 ## 新機能
 * 図・表・リスト・式のキャプションの位置を内容の上側・下側どちらにするかを指定する `caption_position` パラメータを追加しました。`caption_position` の下位パラメータとして `image`・`table`・`list`・`equation` のパラメータがあり、値として `top` (上側) または `bottom` (下側) を指定します。デフォルトは `image` のみ `bottom`、ほかは `top` です ([#1320])

data/NEWS.md

@@ -1,3 +1,97 @@
+# Version 5.0.0
+## New Features
+* added `cover_fit_page` option to review-jsbook / review-jlreq classes. When `cover_fit_page=true` is specified in the `texdocumentclass` parameter, the cover image is scaled to paper size. Note: it is recommended that the images should be created at actual size ([#1534])
+* allow minicolumn nesting. Now you can put a block instruction such as `//image` or itemized list in minicolumn (`//note`, `//memo`, `//tip`, `//info`, `//warning`, `//important`, `//caution`, `//notice`) ([#1558], [#1562])
+* added single commands `//beginchild` and `//endchild` for nesting itemized/enumerate/description list. **EXPERIMENTAL FEATURE** ([#1497])
+
+## Breaking Changes
+* In review-jlreq.cls, hiddenfolio is now implemented by jlreqtrimmarkssetup. It is slightly different from the previous version in position and display ([#1397])
+* The default value of the `chapterlink` parameter is now true. Most links (chapter, section, image, table, list, equation, bibliography) in Web and EPUB are now hyperlinked. In TeX PDF, some links (chapter, section, biliography) are hyperlinked only when `media=ebook` ([#1529])
+
+## Bug Fixes
+* PDFMaker: fixed a problem with multiple same-named image files with different extensions that would cause them to be misaligned ([#1483])
+* PDFMaker: fixed a problem that cuased an error when the author name (`aut`) was empty ([#1517])
+* PDFMaker: fixed a problem that caused an error if `//indepimage`'s image file didn't exist and ID contained characters to be TeX-escaped ([#1527])
+* PDFMaker: fixed a problem with characters to be TeX-escaped in the `bookttilename` and `aut` parameters causing incorrect PDF metainformation ([#1533])
+* WebMaker: fixed to avoid nil in HTML template ([#1545])
+* PDFMaker: fixed a problem when hiding chapter numbers ([#1559])
+* MarkdownBuilder: paragraphs in minicolumn should be separated with a blank line instead of a newline ([#1572])
+
+## Enhancements
+* fix warning message to output more detailed information of item ([#1523])
+* PDFMaker: make `@<hd>` op a hyperlink (when `media=ebook`) ([#1530])
+* use `cgi/escape` first and `cgi/util` as fallback. remove orignal implementation in `ReVIEW::HTMLUtils.escape()` ([#1536])
+* suppress warning with same `@<icon>` ([#1541])
+* fix an error handling when a badly encoded file is received ([#1544])
+* introduce IndexBuilder. IndexBuilder first scans the entire project files and provides indexes for each builder ([#1384], [#1552])
+* IDs and labels containing below characters or space characters are now warned ([#1393], [#1574])
+```
+#%\{}[]~/$'"|*?&<>`
+```
+
+## Docs
+* fix a typo in format.ja.md and format.md ([#1528])
+* fix incorrect example in makeindex.ja.md ([#1584])
+
+## Others
+* refactor code with Rubocop 0.92.0 ([#1511], [#1569], [#1573])
+* rename `@strategy` to `@builder` in `Re:VIEW::Compiler` ([#1520])
+* refactor code with Rubocop-performance 1.7.1 ([#1521])
+* update Gemfile in syntax-book ([#1522])
+* calling GhostScript in ImageMagick has been deprecated, so the test has been removed ([#1526])
+* unnecessary stderr output on some test units has been suppressed ([#1538])
+* add `BookUnit` class instead of `Compilable` module, the super class of `Chapter` and `Part` ([#1543])
+* `ReVIEW::Book.load` is deprecated, use `ReVIEW::Book::Base.load` or `ReVIEW::Book::Base.new` add new option `:config` for `ReVIEW::Book::Base.load` ([#1548], [#1563])
+* added `ReVIEW::Configure.create` ([#1549])
+* WebMaker: removed unused `clean_mathdir` ([#1550])
+* add `Base#parse_catalog_file()` and use it in `ReVIEW::Book::Base.new()`. `Base#catalog` is just getter now  ([#1551])
+* use `File.write` when it can be used ([#1560])
+* remove `Builder#builder_init()` ([#1564])
+
+## Contributors
+* [@snoozer05](https://github.com/snoozer05)
+
+[#1384]: https://github.com/kmuto/review/pull/1384
+[#1393]: https://github.com/kmuto/review/issues/1393
+[#1397]: https://github.com/kmuto/review/issues/1397
+[#1483]: https://github.com/kmuto/review/issues/1483
+[#1497]: https://github.com/kmuto/review/pull/1497
+[#1511]: https://github.com/kmuto/review/pull/1511
+[#1517]: https://github.com/kmuto/review/issues/1517
+[#1520]: https://github.com/kmuto/review/pull/1520
+[#1521]: https://github.com/kmuto/review/pull/1521
+[#1522]: https://github.com/kmuto/review/pull/1522
+[#1523]: https://github.com/kmuto/review/pull/1523
+[#1526]: https://github.com/kmuto/review/pull/1526
+[#1527]: https://github.com/kmuto/review/pull/1527
+[#1528]: https://github.com/kmuto/review/pull/1528
+[#1529]: https://github.com/kmuto/review/issues/1529
+[#1530]: https://github.com/kmuto/review/issues/1530
+[#1533]: https://github.com/kmuto/review/issues/1533
+[#1534]: https://github.com/kmuto/review/issues/1534
+[#1536]: https://github.com/kmuto/review/pull/1536
+[#1538]: https://github.com/kmuto/review/pull/1538
+[#1541]: https://github.com/kmuto/review/pull/1541
+[#1543]: https://github.com/kmuto/review/pull/1543
+[#1544]: https://github.com/kmuto/review/issues/1544
+[#1545]: https://github.com/kmuto/review/issues/1545
+[#1548]: https://github.com/kmuto/review/pull/1548
+[#1549]: https://github.com/kmuto/review/pull/1549
+[#1550]: https://github.com/kmuto/review/pull/1550
+[#1551]: https://github.com/kmuto/review/pull/1551
+[#1552]: https://github.com/kmuto/review/pull/1552
+[#1558]: https://github.com/kmuto/review/pull/1558
+[#1559]: https://github.com/kmuto/review/issues/1559
+[#1560]: https://github.com/kmuto/review/pull/1560
+[#1562]: https://github.com/kmuto/review/pull/1562
+[#1563]: https://github.com/kmuto/review/pull/1563
+[#1564]: https://github.com/kmuto/review/pull/1564
+[#1569]: https://github.com/kmuto/review/pull/1569
+[#1572]: https://github.com/kmuto/review/pull/1572
+[#1573]: https://github.com/kmuto/review/pull/1573
+[#1574]: https://github.com/kmuto/review/issues/1574
+[#1584]: https://github.com/kmuto/review/pull/1584
+
 # 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])