review 5.0.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a64963e856714bc3b342e5b436d5a78f310785cfcad7216afa8a1676ea8b22b1
-  data.tar.gz: a43be15aee421f6e864d7ba2007981717786ee359bb70d358cb9e4794827a47c
+  metadata.gz: f75b248a75c068752f6940450fce0815923dd26423d339b50df3b137601742e0
+  data.tar.gz: 37607fe69c2fa934968ee1a0f2f66415ee341b5ac777480a19d97086f99a9c15
 SHA512:
-  metadata.gz: 12d7b001415a9e5f1b38f652ec4b3e89d8ad55661eb20fd911e0e626e1f8b3651844816ed209fa6f015524dcf2ff6f2c604ad5427ebbed91d21187e62f8629d5
-  data.tar.gz: 95a137a10cf78f204a3ee1d94d078f4ebe24b9b5a710c43cd41fee30d04c40ce9d350d121cd76952df5a2f01bcb9166588e287399a71cd308ff4bae31cae128e
+  metadata.gz: 88444aa04c1503229eab1a1342d672f9149f499ebc3d15025134f3bdbf96fe1036a96ae9729622eea72fcf39b42aead1c17a1fa802e51838d9dfe25d5e8b5df8
+  data.tar.gz: 7096c49f6db52f29d81ec977479803fc55f6772d319ea96d30e673a72638a59d2031ca4bc88453d83e85e1141a1984724b2a88e253b6b786abe7a2c090565426

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

@@ -0,0 +1,35 @@
+name: Test with TeXLive
+
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+
+jobs:
+  build:
+
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.5, 3.0]
+        os: [ubuntu-20.04]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install TeXLive 2020 in ubuntu
+      if: runner.os == 'Linux'
+      run: |
+        sudo apt-get update -y -qq && sudo apt-get install -y -qq texlive-lang-japanese texlive-fonts-recommended texlive-fonts-extra texlive-luatex texlive-extra-utils texlive-latex-extra dvipng poppler-utils
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: fix ImageMagick policy.xml on Linux
+      if: runner.os == 'Linux'
+      run: sudo sed -i 's/none/read|write/g' /etc/ImageMagick-6/policy.xml
+    - name: Build and test with Rake
+      run: |
+        gem install bundler --no-document
+        bundle install --retry 3
+        bundle exec rake

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

@@ -1,6 +1,10 @@
 name: TestWin
 
-on: [push]
+on:
+  push:
+    branches:
+    - master
+  pull_request:
 
 jobs:
   build:
@@ -9,12 +13,12 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.6.x', '2.5.x', '2.4.x' ]
+        ruby: [ '3.0', '2.7', '2.6', '2.5', '2.4' ]
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v2
     - name: Set up Ruby
-      uses: actions/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
     - name: Build and test with Rake

data/.github/workflows/ruby.yml

@@ -1,6 +1,10 @@
 name: Test
 
-on: [push]
+on:
+  push:
+    branches:
+    - master
+  pull_request:
 
 jobs:
   build:
@@ -9,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.4, 2.5, 2.6, 2.7]
+        ruby: [2.4, 2.5, 2.6, 2.7, 3.0]
         os: [ubuntu-latest, macOS-latest]
     steps:
     - uses: actions/checkout@v2

data/.rubocop.yml

@@ -1,14 +1,15 @@
 AllCops:
   Exclude:
-    - lib/lineinput.rb
     - lib/uuid.rb
     - test/syntax-book/*
     - tmp/*
   DisplayCopNames: true
   NewCops: enable
+  TargetRubyVersion: 2.5
 
 require:
   - rubocop-performance
+  - rubocop-rake
 
 #### Lint
 
@@ -52,6 +53,13 @@ Lint/RaiseException:
 Lint/StructNewOverride:
   Enabled: true
 
+# make it enable when supporting only Ruby 3.0 and higher.
+Lint/RedundantDirGlobSort:
+  Enabled: false
+
+Lint/ElseLayout:
+  Enabled: false
+
 #### Performance
 
 Performance/RegexpMatch:
@@ -62,7 +70,7 @@ Performance/ReverseEach:
 
 # Use tr instead of gsub.
 Performance/StringReplacement:
-  Enabled: false
+  Enabled: true
 
 Performance/RangeInclude:
   Enabled: true
@@ -135,6 +143,9 @@ Style/ClassMethods:
 Style/CommentedKeyword:
   Enabled: false
 
+Style/DocumentDynamicEvalDefinition:
+  Enabled: false
+
 Style/FloatDivision:
   Enabled: false
 
@@ -172,7 +183,7 @@ Style/GuardClause:
   Enabled: false
 
 Style/IfInsideElse:
-  Enabled: false
+  Enabled: true
 
 Style/IfUnlessModifier:
   Enabled: false
@@ -247,6 +258,8 @@ Style/MethodCallWithArgsParentheses:
     - 'write'
     - 'warn'
     - 'error'
+    - 'error!'
+    - 'app_error'
     - 'raise'
     - 'yield'
     - 'source'
@@ -420,7 +433,7 @@ Layout/EmptyLines:
   Enabled: true
 
 Layout/EmptyLineAfterGuardClause:
-  Enabled: false
+  Enabled: true
 
 Layout/EmptyLinesAroundAccessModifier:
   Enabled: true
@@ -435,7 +448,7 @@ Layout/EmptyLinesAroundModuleBody:
   Enabled: true
 
 Layout/EndOfLine:
-  Enabled: false
+  Enabled: true
 
 Layout/ExtraSpacing:
   Enabled: true
@@ -456,7 +469,7 @@ Layout/LeadingCommentSpace:
   Enabled: true
 
 Layout/MultilineOperationIndentation:
-  Enabled: false
+  Enabled: true
 
 Layout/SpaceAroundBlockParameters:
   EnforcedStyleInsidePipes: no_space
@@ -478,7 +491,7 @@ Layout/SpaceAroundOperators:
   Enabled: true
 
 Layout/SpaceBeforeBlockBraces:
-  Enabled: false
+  Enabled: true
 
 Layout/SpaceBeforeComma:
   Enabled: true
@@ -543,7 +556,7 @@ Metrics/MethodLength:
 
 ### should be < 20
 Metrics/CyclomaticComplexity:
-  Max: 32
+  Max: 25
 
 ### should be < 60
 Metrics/AbcSize:
@@ -577,7 +590,7 @@ Naming/HeredocDelimiterNaming:
   Enabled: false
 
 Naming/MemoizedInstanceVariableName:
-  Enabled: false
+  Enabled: true
 
 Naming/MethodName:
   Enabled: true
@@ -592,6 +605,8 @@ Naming/VariableName:
 Naming/VariableNumber:
   EnforcedStyle: normalcase
   Enabled: true
+  Exclude:
+    - test/*
 
 #### Security
 

data/NEWS.ja.md

@@ -1,3 +1,218 @@
+# Version 5.3.0
+## 新機能
+* 後注のサポートを追加しました。`//endnote` 命令で後注内容、`@<endnote>` 命令で後注参照、`//printendnotes` 命令で後注を配置する場所を指定します ([#1724])
+
+## バグ修正
+* 新しい jlreq において ifthen パッケージに非依存になったことによるエラーを修正しました ([#1718])
+* review-jsbook と新しい TeXLive 2020 以降の組み合わせにおいて、隠しノンブルがすべて1になってしまう問題を修正しました ([#1720])
+* coverimage パラメータに実際に存在しないファイルを指定したときに例外エラーが発生するのを修正しました ([#1726], [#1729])
+* titlefile・creditfile・profile パラメータに存在しないファイルを指定したときに警告を表示するようにしました ([#1730])
+* review-jlreq で `@<tcy>` 命令がエラーになるのを修正しました。縦中横の TeX 表現側での抽象名に `\reviewtcy` マクロを使うようにしました ([#1733])
+* review-vol および review-index の例外エラーを修正しました ([#1740])
+* 数式ビルドエラーが出たときに `__IMGMATH_BODY__.tex` のコピーを忘れているのを修正しました ([#1747])
+* `//beginchild`・`//endchild` 命令でエラーが起きたときにエラー位置の表示がされていなかったのを修正しました ([#1742])
+* `//graph` 命令を使うとビルドエラーになるのを修正しました ([#1744])
+* epubmaker.rb で未定義の変数を参照している箇所を修正しました ([#1755])
+* review-catalog-converter がエラーになるのを修正しました ([#1753])
+
+## 機能強化
+* 脚注 (`//footnote`)・後注(`//endnote`) を定義したけれども参照（`@<fn>`、`@<endnote>`）していないときに警告するようにしました ([#1725])
+* 紙面全体に画像を貼り込む `\includefullpagegraphics` マクロを縦書きにも対応するようにしました ([#1734])
+* plantuml の jar ファイル探索先を作業フォルダのほか、`/usr/share/plantuml`、`/usr/share/java` からも探すようにしました ([#1760])
+
+## ドキュメント
+* format.ja.md, format.md: SVG数式を作成するコマンドラインの間違いを修正しました ([#1748])
+
+## その他
+* Windows 版 Ruby 2.7 のテストを追加しました ([#1743])
+* Rubocop 1.22.1 に対応しました ([#1759])
+
+## コントリビューターのみなさん
+* [@munepi](https://github.com/munepi)
+* [@huideyeren](https://github.com/huideyeren)
+
+[#1718]: https://github.com/kmuto/review/issues/1718
+[#1720]: https://github.com/kmuto/review/issues/1720
+[#1724]: https://github.com/kmuto/review/issues/1724
+[#1725]: https://github.com/kmuto/review/issues/1725
+[#1726]: https://github.com/kmuto/review/issues/1726
+[#1729]: https://github.com/kmuto/review/pull/1729
+[#1730]: https://github.com/kmuto/review/pull/1730
+[#1733]: https://github.com/kmuto/review/issues/1733
+[#1734]: https://github.com/kmuto/review/issues/1734
+[#1740]: https://github.com/kmuto/review/pull/1740
+[#1742]: https://github.com/kmuto/review/pull/1742
+[#1743]: https://github.com/kmuto/review/pull/1743
+[#1744]: https://github.com/kmuto/review/issues/1744
+[#1747]: https://github.com/kmuto/review/pull/1747
+[#1748]: https://github.com/kmuto/review/pull/1748
+[#1753]: https://github.com/kmuto/review/issues/1753
+[#1755]: https://github.com/kmuto/review/issues/1755
+[#1759]: https://github.com/kmuto/review/pull/1759
+[#1760]: https://github.com/kmuto/review/pull/1760
+
+# Version 5.2.0
+## 新機能
+* EPUBMaker: CSS 組版向けに、見出しの存在に応じて `<section>` で階層化する機能を追加しました。config.yml で `epubmaker` セクションの `use_section` パラメータを `true` にすると有効化されます ([#1685])
+
+## バグ修正
+* PDFMaker: Ruby 2.6 以上でテンプレートの引数についての警告が出る問題を修正しました ([#1683])
+* EPUBMaker: Docker 環境においてファイルがコピーされず空になる問題を修正しました ([#1686])
+* 縦中横を正しく表示する CSS 設定を追加しました ([#1688])
+* PDFMaker: 新しい TeXLive との組み合わせで pxjahyper のオプション競合エラーが発生するのを修正しました ([#1690])
+* PDFMaker: 画像が見つからないときにコンパイルエラーになるのを修正しました ([#1706])
+
+## 機能強化
+* 警告とエラーを出力する際の処理を改善しました。`error!` (すぐに終了) および `app_error` (`ApplicationError` 例外を上げる) メソッドを導入しました ([#1674])
+* PDFMaker: ビルドのために画像ファイルをコピーする際、実コピーではなくシンボリックリンクを利用して処理を高速化するオプションを追加しました。`pdfmaker` セクションの `use_symlink` パラメータを `true` にすると、デフォルト挙動の実コピーの代わりにシンボリックリンクが使われます。Windows など一部の OS ではこれは動作しない可能性があります ([#1696])
+* PDFMaker: review-jlreq で `serial_pagination=true, openany` を指定したときには前付の後の空ページが入らないようにしました ([#1711])
+
+## その他
+* GitHub Actions まわりを修正しました ([#1684], [#1691])
+* review-preproc: リファクタリングを行いました ([#1697])
+* 入れ子の箇条書きの処理をリファクタリングしました ([#1698])
+* Rubocop 1.12 に対応しました ([#1689], [#1692], [#1699], [#1700])
+* 各ビルダの `builder_init_file` メソッドで最初に `super` で基底 builder の `builder_init_file` を実行するようにしました ([#1702])
+* PDFMaker: FileUtils ライブラリを内部で使う際に、明示記法の `FIleUtils.foobar` を使うようにしました ([#1704])
+
+## コントリビューターのみなさん
+* [@odaki](https://github.com/odaki)
+* [@imamurayusuke](https://github.com/imamurayusuke)
+
+[#1674]: https://github.com/kmuto/review/issues/1674
+[#1683]: https://github.com/kmuto/review/pulls/1683
+[#1684]: https://github.com/kmuto/review/pulls/1684
+[#1685]: https://github.com/kmuto/review/pulls/1685
+[#1686]: https://github.com/kmuto/review/issues/1686
+[#1688]: https://github.com/kmuto/review/pulls/1688
+[#1689]: https://github.com/kmuto/review/pulls/1689
+[#1690]: https://github.com/kmuto/review/pulls/1690
+[#1691]: https://github.com/kmuto/review/pulls/1691
+[#1692]: https://github.com/kmuto/review/pulls/1692
+[#1696]: https://github.com/kmuto/review/issues/1696
+[#1697]: https://github.com/kmuto/review/pulls/1697
+[#1698]: https://github.com/kmuto/review/pulls/1698
+[#1699]: https://github.com/kmuto/review/pulls/1699
+[#1700]: https://github.com/kmuto/review/pulls/1700
+[#1702]: https://github.com/kmuto/review/pulls/1702
+[#1704]: https://github.com/kmuto/review/pulls/1704
+[#1706]: https://github.com/kmuto/review/issues/1706
+[#1711]: https://github.com/kmuto/review/issues/1711
+
+# Version 5.1.1
+## バグ修正
+* `review-preproc` がエラーになるのを修正しました ([#1679])
+
+[#1679]: https://github.com/kmuto/review/issues/1679
+
+# Version 5.1.0
+## 新機能
+* CSS 組版ソフトウェア [Vivliostyle-CLI](https://github.com/vivliostyle/vivliostyle-cli) を呼び出す Rake ルールを追加しました。Vivliostyle-CLI をインストールした環境において、`rake vivliostyle:build` または `rake vivliostyle` で PDF を作成、`rake vivliostyle:preview` でブラウザのプレビューが開きます ([#1663])
+* PDFMaker: `config.yml` に `boxsetting` パラメータを新設し、column・note・memo・tip・info・warning・important・caution・notice の囲み飾りを事前定義のものや独自に作成したものから選択およびカスタマイズできるようにしました ([#1637])
+* 挿入箇所を示す `@<ins>`、削除箇所を示す `@<del>` の2つのインライン命令を追加しました ([#1630])
+* EPUBMaker, WebMaker: 数式表現手法として MathJax をサポートし、数式表現手法を `math_format` パラメータで選択するようにしました ([#1587], [#1614])
+
+## 非互換の変更
+* EPUBMaker: `urnid` パラメータのデフォルト値のプレフィクスを、`urn:uid` から `urn:uuid` に変更しました ([#1658])
+* PDFMaker: 長い脚注がページ分断されないようにしました ([#1607])
+
+## バグ修正
+* `contentdir` を設定しているときに WebMaker, review-vol, review-index がエラーになるのを修正しました ([#1633])
+* WebMaker: `images/html` 図版フォルダが見つけられないのを修正しました ([#1623])
+* PDFMaker: 用語リストの見出しで chapterlink がおかしな結果になるのを修正しました ([#1619])
+* PDFMaker: 索引に `{`, `}`, `|` が含まれているときにエラーや奇妙な文字に変換されるのを修正しました ([#1611])
+* review-vol: 不正な見出しがあったときに妥当なエラーメッセージを出力するようにしました ([#1604])
+* PDFMaker: `after_makeindex` フックを LaTeX コンパイル後ではなく `mendex` 実行後に実行するように修正しました ([#1605])
+* PDFMaker: `//image` のキャプションが空だったときに内部エラーではなく図番号が出力されるように修正しました ([#1666])
+* review-vol, review-index が不正なファイルを受け取ったときのエラー処理を修正しました ([#1671])
+* EPUBMaker: author などの静的ファイルを指示したときに、ファイルが存在しないと内部エラーを起こしていたのを修正しました ([#1670])
+
+## 機能強化
+* tty-loger gem パッケージがインストールされている場合、Re:VIEW の各 Maker コマンドの進行状態をアイコンおよびカラーで示すようにしました ([#1660])
+* PDFMaker: クラスファイルで `\RequirePackage{plautopatch}` を最初に評価するようにしました ([#1644])
+* MARKDOWNBuilder: `@<hd>` をサポートしました ([#1629])
+* Re:VIEW ドキュメントファイルに不正なエスケープシーケンス文字が含まれているときにエラーを出すようにしました ([#1596], [#1602])
+* `=` の数が6を超える見出し扱いの行があるときにエラーを出すようにしました ([#1591])
+
+## ドキュメント
+* 画像探索の際に各 Maker が参照するサブフォルダ名について記載しました ([#1626])
+
+## その他
+* EPUBMaker: EPUB ライブラリ一式を `lib/epubmaker` から `lib/review/epubmaker` に移動し、リファクタリングしました ([#1575], [#1617], [#1635], [#1640], [#1641], [#1650], [#1653], [#1655])
+* EPUBMaker: テストを追加しました ([#1656])
+* PDFMaker: いくつかの処理をリファクタリングしました ([#1664])
+* 数式画像生成処理を `ReVIEW::ImgMath` クラスにまとめました ([#1642], [#1649], [#1659], [#1662])
+* IDGXMLMaker: いくつかの処理をリファクタリングしました ([#1654])
+* MakerHelper: いくつかの処理をリファクタリングしました ([#1652])
+* テンプレート処理を `ReVIEW::Template.generate` メソッドに統一しました ([#1648])
+* GitHub Actions で TeX コンパイルのテストも行うようにしました ([#1643])
+* Rubocop 1.10 に対応しました ([#1593], [#1598], [#1613], [#1636], [#1647], [#1669])
+* サンプル syntax-book の重複 ID を修正しました ([#1646])
+* ライブラリの相対パスの参照方法をリファクタリングしました ([#1639])
+* `ReVIEW::LineInput` クラスをリファタクタリングしました ([#1638])
+* Copyright を2021年に更新しました ([#1632])
+* Ruby 3.0 でのテストを実行するようにしました ([#1622])
+* 不安定な Pygments のテストを抑制しました ([#1610], [#1618])
+* WebTocPrinter: テストのエラーを修正しました ([#1606])
+* テストのターゲットを指定しやすいようにしました ([#1594])
+
+[#1671]: https://github.com/kmuto/review/issues/1671
+[#1670]: https://github.com/kmuto/review/pull/1670
+[#1669]: https://github.com/kmuto/review/pull/1669
+[#1666]: https://github.com/kmuto/review/issues/1666
+[#1664]: https://github.com/kmuto/review/pull/1664
+[#1663]: https://github.com/kmuto/review/pull/1663
+[#1662]: https://github.com/kmuto/review/issues/1662
+[#1660]: https://github.com/kmuto/review/issues/1660
+[#1659]: https://github.com/kmuto/review/pull/1659
+[#1658]: https://github.com/kmuto/review/pull/1658
+[#1656]: https://github.com/kmuto/review/pull/1656
+[#1655]: https://github.com/kmuto/review/pull/1655
+[#1654]: https://github.com/kmuto/review/pull/1654
+[#1653]: https://github.com/kmuto/review/pull/1653
+[#1652]: https://github.com/kmuto/review/pull/1652
+[#1650]: https://github.com/kmuto/review/pull/1650
+[#1649]: https://github.com/kmuto/review/pull/1649
+[#1648]: https://github.com/kmuto/review/pull/1648
+[#1647]: https://github.com/kmuto/review/pull/1647
+[#1646]: https://github.com/kmuto/review/pull/1646
+[#1644]: https://github.com/kmuto/review/issues/1644
+[#1643]: https://github.com/kmuto/review/pull/1643
+[#1642]: https://github.com/kmuto/review/pull/1642
+[#1641]: https://github.com/kmuto/review/pull/1641
+[#1640]: https://github.com/kmuto/review/pull/1640
+[#1639]: https://github.com/kmuto/review/pull/1639
+[#1638]: https://github.com/kmuto/review/pull/1638
+[#1637]: https://github.com/kmuto/review/pull/1637
+[#1636]: https://github.com/kmuto/review/pull/1636
+[#1635]: https://github.com/kmuto/review/pull/1635
+[#1633]: https://github.com/kmuto/review/issues/1633
+[#1632]: https://github.com/kmuto/review/issues/1632
+[#1630]: https://github.com/kmuto/review/issues/1630
+[#1629]: https://github.com/kmuto/review/pull/1629
+[#1626]: https://github.com/kmuto/review/pull/1626
+[#1623]: https://github.com/kmuto/review/issues/1623
+[#1622]: https://github.com/kmuto/review/pull/1622
+[#1619]: https://github.com/kmuto/review/issues/1619
+[#1618]: https://github.com/kmuto/review/pull/1618
+[#1617]: https://github.com/kmuto/review/pull/1617
+[#1614]: https://github.com/kmuto/review/pull/1614
+[#1613]: https://github.com/kmuto/review/pull/1613
+[#1611]: https://github.com/kmuto/review/issues/1611
+[#1610]: https://github.com/kmuto/review/pull/1610
+[#1607]: https://github.com/kmuto/review/issues/1607
+[#1606]: https://github.com/kmuto/review/issues/1606
+[#1605]: https://github.com/kmuto/review/issues/1605
+[#1604]: https://github.com/kmuto/review/issues/1604
+[#1602]: https://github.com/kmuto/review/pull/1602
+[#1598]: https://github.com/kmuto/review/pull/1598
+[#1596]: https://github.com/kmuto/review/issues/1596
+[#1594]: https://github.com/kmuto/review/pull/1594
+[#1593]: https://github.com/kmuto/review/pull/1593
+[#1591]: https://github.com/kmuto/review/issues/1591
+[#1587]: https://github.com/kmuto/review/issues/1587
+[#1575]: https://github.com/kmuto/review/issues/1575
+
 # Version 5.0.0
 ## 新機能
 * review-jsbook / review-jlreq クラスに、`cover_fit_page` オプションを追加しました。`texdocumentclass` パラメータに `cover_fit_page=true` を付けると、画像サイズがどのようなものであっても仕上がりサイズに拡縮して表紙に貼り込みます。なお、制作において図版は実寸で作成することを推奨します ([#1534])