RubyGems - review - Versions diffs - 2.3.0 → 2.4.0 - Mend

review 2.3.0 → 2.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (160) hide show

checksums.yaml +4 -4
data/.rubocop.yml +90 -66
data/.travis.yml +1 -1
data/Gemfile +0 -1
data/NEWS.ja.md +82 -0
data/NEWS.md +83 -0
data/README.md +5 -3
data/Rakefile +8 -8
data/bin/review +1 -5
data/bin/review-catalog-converter +22 -27
data/bin/review-check +36 -43
data/bin/review-checkdep +10 -15
data/bin/review-compile +37 -55
data/bin/review-epubmaker +4 -5
data/bin/review-index +21 -29
data/bin/review-init +26 -37
data/bin/review-pdfmaker +0 -2
data/bin/review-preproc +25 -45
data/bin/review-validate +19 -18
data/bin/review-vol +15 -27
data/doc/config.yml.sample +5 -2
data/doc/format.ja.md +20 -1
data/doc/format.md +21 -5
data/doc/images/review-generate.png +0 -0
data/lib/epubmaker.rb +1 -3
data/lib/epubmaker/content.rb +24 -27
data/lib/epubmaker/epubcommon.rb +135 -148
data/lib/epubmaker/epubv2.rb +39 -46
data/lib/epubmaker/epubv3.rb +93 -103
data/lib/epubmaker/producer.rb +138 -151
data/lib/epubmaker/zip_exporter.rb +21 -26
data/lib/review/book.rb +3 -6
data/lib/review/book/base.rb +78 -103
data/lib/review/book/chapter.rb +36 -40
data/lib/review/book/compilable.rb +28 -31
data/lib/review/book/image_finder.rb +6 -13
data/lib/review/book/index.rb +100 -121
data/lib/review/book/page_metric.rb +2 -7
data/lib/review/book/part.rb +18 -20
data/lib/review/book/volume.rb +9 -13
data/lib/review/builder.rb +81 -116
data/lib/review/catalog.rb +15 -19
data/lib/review/compiler.rb +64 -83
data/lib/review/configure.rb +87 -97
data/lib/review/converter.rb +2 -7
data/lib/review/epubbuilder.rb +1 -3
data/lib/review/epubmaker.rb +213 -205
data/lib/review/exception.rb +2 -4
data/lib/review/extentions.rb +0 -1
data/lib/review/extentions/hash.rb +2 -2
data/lib/review/extentions/string.rb +5 -30
data/lib/review/htmlbuilder.rb +320 -375
data/lib/review/htmltoc.rb +4 -7
data/lib/review/htmlutils.rb +29 -32
data/lib/review/i18n.rb +33 -44
data/lib/review/i18n.yml +3 -3
data/lib/review/idgxmlbuilder.rb +309 -345
data/lib/review/latexbuilder.rb +175 -212
data/lib/review/latexindex.rb +2 -8
data/lib/review/latexutils.rb +33 -43
data/lib/review/lineinput.rb +1 -1
data/lib/review/logger.rb +21 -0
data/lib/review/makerhelper.rb +1 -4
data/lib/review/markdownbuilder.rb +44 -53
data/lib/review/md2inaobuilder.rb +6 -12
data/lib/review/pdfmaker.rb +143 -173
data/lib/review/preprocessor.rb +64 -101
data/lib/review/rstbuilder.rb +126 -158
data/lib/review/sec_counter.rb +18 -34
data/lib/review/template.rb +4 -5
data/lib/review/textbuilder.rb +2 -3
data/lib/review/textutils.rb +7 -13
data/lib/review/tocparser.rb +31 -56
data/lib/review/tocprinter.rb +26 -52
data/lib/review/topbuilder.rb +219 -247
data/lib/review/unfold.rb +15 -24
data/lib/review/version.rb +1 -1
data/lib/review/webmaker.rb +75 -99
data/lib/review/webtocprinter.rb +15 -20
data/lib/review/yamlloader.rb +13 -15
data/review.gemspec +20 -22
data/templates/latex/layout.tex.erb +2 -2
data/templates/opf/epubv2.opf.erb +7 -7
data/templates/opf/epubv3.opf.erb +7 -7
data/templates/web/html/layout-html5.html.erb +2 -2
data/test/assets/black.eps +280 -0
data/test/assets/fit.png +0 -0
data/test/assets/large.gif +0 -0
data/test/assets/large.jpg +0 -0
data/test/assets/large.png +0 -0
data/test/assets/large.svg +65 -0
data/test/assets/test_template.tex +1 -1
data/test/book_test_helper.rb +2 -2
data/test/run_test.rb +4 -4
data/test/sample-book/src/Rakefile +21 -22
data/test/syntax-book/Gemfile +4 -0
data/test/syntax-book/Rakefile +72 -0
data/test/syntax-book/appA.re +22 -0
data/test/syntax-book/bib.re +6 -0
data/test/syntax-book/catalog.yml +15 -0
data/test/syntax-book/ch01.re +136 -0
data/test/syntax-book/ch02.re +351 -0
data/test/syntax-book/ch03.re +82 -0
data/test/syntax-book/config.yml +35 -0
data/test/syntax-book/images/ball.png +0 -0
data/test/syntax-book/images/cover.jpg +0 -0
data/test/syntax-book/images/fractal.png +0 -0
data/test/syntax-book/images/img3-1.png +0 -0
data/test/syntax-book/images/inlineicon.jpg +0 -0
data/test/syntax-book/images/logic.png +0 -0
data/test/syntax-book/images/logic2.png +0 -0
data/test/syntax-book/images/puzzle.jpg +0 -0
data/test/syntax-book/images/table.jpg +0 -0
data/test/syntax-book/part2.re +6 -0
data/test/syntax-book/pre01.re +26 -0
data/test/syntax-book/review-ext.rb +14 -0
data/test/syntax-book/sty/jumoline.sty +310 -0
data/test/syntax-book/sty/reviewmacro.sty +39 -0
data/test/syntax-book/style.css +494 -0
data/test/syntax-book/syntax.dic +2 -0
data/test/test_book.rb +106 -111
data/test/test_book_chapter.rb +21 -22
data/test/test_book_part.rb +3 -5
data/test/test_builder.rb +11 -22
data/test/test_catalog.rb +17 -18
data/test/test_catalog_converter_cmd.rb +5 -5
data/test/test_compiler.rb +18 -16
data/test/test_configure.rb +35 -38
data/test/test_converter.rb +3 -4
data/test/test_epub3maker.rb +136 -117
data/test/test_epubmaker.rb +107 -114
data/test/test_epubmaker_cmd.rb +2 -4
data/test/test_extentions_hash.rb +32 -33
data/test/test_helper.rb +9 -11
data/test/test_htmlbuilder.rb +454 -420
data/test/test_htmltoc.rb +8 -12
data/test/test_htmlutils.rb +0 -2
data/test/test_i18n.rb +159 -150
data/test/test_idgxmlbuilder.rb +190 -197
data/test/test_image_finder.rb +21 -22
data/test/test_index.rb +24 -29
data/test/test_latexbuilder.rb +274 -264
data/test/test_lineinput.rb +7 -10
data/test/test_location.rb +7 -7
data/test/test_makerhelper.rb +13 -25
data/test/test_markdownbuilder.rb +23 -26
data/test/test_md2inaobuilder.rb +8 -11
data/test/test_pdfmaker.rb +114 -123
data/test/test_pdfmaker_cmd.rb +1 -3
data/test/test_review_ext.rb +3 -5
data/test/test_rstbuilder.rb +92 -97
data/test/test_template.rb +3 -7
data/test/test_textutils.rb +27 -27
data/test/test_tocparser.rb +2 -2
data/test/test_topbuilder.rb +98 -103
data/test/test_webtocprinter.rb +5 -6
data/test/test_yamlloader.rb +42 -42
data/test/test_zip_exporter.rb +12 -18
metadata +86 -9
data/lib/review/ewbbuilder.rb +0 -382

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82d28fa3ffbcbcc1cf5a4bdb81a4e465d32ba530
-  data.tar.gz: d0d1914dcce4b11276ef4b097252265986e74425
+  metadata.gz: 639a13776cef44b59eb3464cff41726186d37bb1
+  data.tar.gz: f285c0fb10f02260f16797a412d65287fb035fda
 SHA512:
-  metadata.gz: fd778716edf5e843f81d680bdb5d375d99bb7c893c52a3cee49fb1717cb3328fa9d32f13364f85f3299cf3523538aa0d32f00a0ffb851f9b004b07d9d922184c
-  data.tar.gz: 9e937dfde5a4bbe29c5621ff88695bad140d4baddbb20233bc9c4ccce22b328d5ffb63219501464f0ca196798d887cc57577de1d498eb21f6dd36a50ee971cad
+  metadata.gz: 157a8ad3ee0078e7c2a3e3c2bc3fc18f9a2f7f56474384884f750b5ff4d13acdb4514d89777d4d418e315b25e909c3eb52f89a0e8b2411ea2fc23bea6a0091b9
+  data.tar.gz: 4112950e237224284a1d04efb1b391f427acb043ab121040bfe11e0055a32c7a4a57b8c349755d693da7ea62a80709e9f1d7bf1a7666e194a5011bff13fccb67

data/.rubocop.yml CHANGED

@@ -2,6 +2,7 @@ AllCops:
   Exclude:
     - lib/lineinput.rb
     - lib/uuid.rb
+    - test/syntax-book/*
   DisplayCopNames: true
 inherit_from: .rubocop_todo.yml
@@ -15,7 +16,7 @@ Lint/EndAlignment:
   Enabled: AlignWith
 Lint/EmptyWhen:
-  Enabled: false
+  Enabled: true
 Lint/NestedMethodDefinition:
   Exclude:
@@ -25,24 +26,27 @@ Lint/AssignmentInCondition:
   Enabled: false
 Lint/ParenthesesAsGroupedExpression:
+  Enabled: true
+Lint/RescueWithoutErrorClass:
   Enabled: false
 Lint/UnderscorePrefixedVariableName:
-  Enabled: false
+  Enabled: true
 Lint/UnusedBlockArgument:
-  Enabled: false
+  Enabled: true
 Lint/UnusedMethodArgument:
-  Enabled: false
+  Enabled: true
 Lint/UselessAssignment:
-  Enabled: false
+  Enabled: true
 #### Performance
 Performance/RegexpMatch:
-  Enabled: false
+  Enabled: true
 Performance/ReverseEach:
   Enabled: true
@@ -52,13 +56,10 @@ Performance/StringReplacement:
   Enabled: false
 Performance/RangeInclude:
-  Enabled: false
+  Enabled: true
 #### Style
-Style/AccessorMethodName:
-  Enabled: false
 Style/AsciiComments:
   Enabled: false
@@ -75,7 +76,7 @@ Style/BarePercentLiterals:
   Enabled: true
 Style/BlockDelimiters:
-  Enabled: false
+  Enabled: true
 Style/BracesAroundHashParameters:
   Enabled: false
@@ -84,9 +85,12 @@ Style/CaseEquality:
   Enabled: false
 Style/ClassCheck:
-  Enabled: false
+  Enabled: true
 Style/ClassMethods:
+  Enabled: true
+Style/CommentedKeyword:
   Enabled: false
 # Do not introduce global variables.
@@ -97,22 +101,17 @@ Style/GlobalVars:
 Style/SelfAssignment:
   Enabled: true
-# When defining the == operator, name its argument other.
-Style/OpMethod:
-  Enabled: true
-# Use snake_case for variable names.
-Style/VariableName:
-  Enabled: true
 Style/ConditionalAssignment:
   Enabled: false
 Style/Documentation:
   Enabled: false
+Style/Encoding:
+  Enabled: true
 Style/EmptyElse:
-  Enabled: false
+  Enabled: true
 Style/FormatString:
   EnforcedStyle: sprintf
@@ -125,19 +124,19 @@ Style/IfInsideElse:
   Enabled: false
 Style/IfUnlessModifier:
-  Enabled: false
+  Enabled: true
 Style/MutableConstant:
   Enabled: false
-Style/MultipleComparison:
-  Enabled: false
+#Style/MultipleComparison:
+#  Enabled: true
 Style/UnneededInterpolation:
-  Enabled: false
+  Enabled: true
 Performance/RedundantMerge:
-  Enabled: false
+  Enabled: true
 Style/ZeroLengthPredicate:
   Enabled: false
@@ -149,17 +148,10 @@ Style/NumericPredicate:
 Style/TernaryParentheses:
   Enabled: false
-Style/VariableNumber:
-  EnforcedStyle: normalcase
-  Enabled: true
 Style/FrozenStringLiteralComment:
   EnforcedStyle: never
   Enabled: true
-MultilineMethodCallBraceLayout:
-  Enabled: false
 Style/SafeNavigation:
   Enabled: false
@@ -168,7 +160,7 @@ Style/EmptyMethod:
   Enabled: true
 Style/HashSyntax:
-  Enabled: false
+  Enabled: true
 Style/RescueModifier:
   Enabled: false
@@ -184,25 +176,22 @@ Style/For:
   Enabled: true
 Style/InfiniteLoop:
-  Enabled: false
+  Enabled: true
 Style/LineEndConcatenation:
   Enabled: false
 Style/MethodCallWithoutArgsParentheses:
-  Enabled: false
-Style/MethodName:
-  Enabled: false
+  Enabled: true
 Style/MultilineBlockChain:
-  Enabled: false
+  Enabled: true
 Style/NegatedIf:
-  Enabled: false
+  Enabled: true
 Style/Next:
-  Enabled: false
+  Enabled: true
 Style/Not:
   Enabled: true
@@ -211,7 +200,7 @@ Style/NumericLiterals:
   MinDigits: 6
 Style/PercentLiteralDelimiters:
-  Enabled: false
+  Enabled: true
 Style/PercentQLiterals:
   EnforcedStyle: upper_case_q
@@ -220,17 +209,24 @@ Style/PercentQLiterals:
 Style/PerlBackrefs:
   Enabled: false
+Style/RaiseArgs:
+  EnforcedStyle: exploded
+  Enabled: true
 Style/RedundantBegin:
   Enabled: false
+Style/RedundantParentheses:
+  Enabled: true
 Style/RedundantReturn:
-  Enabled: false
+  Enabled: true
 Style/RedundantSelf:
   Enabled: false
 Style/RegexpLiteral:
-  Enabled: false
+  Enabled: true
 Style/Semicolon:
   Enabled: true
@@ -239,22 +235,25 @@ Style/SingleLineMethods:
   Enabled: true
 Style/SpecialGlobalVars:
+  Enabled: true
+Style/StderrPuts:
   Enabled: false
 Style/StringLiterals:
-  Enabled: false
+  Enabled: true
 Style/StringLiteralsInInterpolation:
-  Enabled: false
+  Enabled: true
 Style/SymbolProc:
-  Enabled: false
+  Enabled: true
 Style/SymbolArray:
-  Enabled: false
+  Enabled: true
 Style/TrailingCommaInLiteral:
-  Enabled: false
+  Enabled: true
 Style/WordArray:
   MinSize: 10
@@ -263,12 +262,14 @@ Style/UnneededPercentQ:
   Enabled: false
 Style/WhileUntilModifier:
-  Enabled: false
+  Enabled: true
-Style/YodaCondition:
-  Enabled: false
+#Style/YodaCondition:
+#  Enabled: true
-#### Layout
+### Layout
+Layout/MultilineMethodCallBraceLayout:
+  Enabled: true
 Layout/AccessModifierIndentation:
   EnforcedStyle: indent
@@ -279,19 +280,19 @@ Layout/DotPosition:
   Enabled: true
 Layout/EmptyLines:
-  Enabled: false
+  Enabled: true
 Layout/EmptyLinesAroundAccessModifier:
   Enabled: true
 Layout/EmptyLinesAroundClassBody:
-  Enabled: false
+  Enabled: true
 Layout/EmptyLinesAroundMethodBody:
   Enabled: true
 Layout/EmptyLinesAroundModuleBody:
-  Enabled: false
+  Enabled: true
 Layout/EndOfLine:
   Enabled: false
@@ -312,7 +313,7 @@ Layout/IndentHeredoc:
   Enabled: false
 Layout/LeadingCommentSpace:
-  Enabled: false
+  Enabled: true
 Layout/MultilineOperationIndentation:
   Enabled: false
@@ -322,7 +323,7 @@ Layout/SpaceAroundBlockParameters:
   Enabled: true
 Layout/SpaceAfterComma:
-  Enabled: false
+  Enabled: true
 Layout/SpaceAfterNot:
   Enabled: true
@@ -331,30 +332,29 @@ Layout/SpaceAfterSemicolon:
   Enabled: true
 Layout/SpaceAroundEqualsInParameterDefault:
-  Enabled: false
+  Enabled: true
 Layout/SpaceAroundOperators:
-  Enabled: false
+  Enabled: true
 Layout/SpaceBeforeBlockBraces:
-  Enabled: false
+  Enabled: true
 Layout/SpaceBeforeComma:
   Enabled: true
 Layout/SpaceInsideBlockBraces:
-  Enabled: false
+  Enabled: true
 Layout/SpaceInsideHashLiteralBraces:
-  Enabled: false
+  Enabled: true
 Layout/SpaceInsideStringInterpolation:
   EnforcedStyle: no_space
   Enabled: true
 Layout/TrailingBlankLines:
-  Enabled: false
+  Enabled: true
 #### Metrics
@@ -383,6 +383,7 @@ Metrics/MethodLength:
   Max: 100
   Exclude:
     - "bin/review-*"
+    - "bin/review2*"
     - "test/**/*"
 ### should be < 20
@@ -405,6 +406,29 @@ Metrics/BlockLength:
     - '**/*.rake'
     - 'test/**/*.rb'
+## Naming
+Naming/AccessorMethodName:
+  Enabled: true
+# When defining the == operator, name its argument other.
+#Style/BinaryOperatorParameterName:
+#  Enabled: true
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+Naming/MethodName:
+  Enabled: true
+# Use snake_case for variable names.
+Naming/VariableName:
+  Enabled: true
+Naming/VariableNumber:
+  EnforcedStyle: normalcase
+  Enabled: true
 #### Security
 # we use Date object in config.yml so should use YAML.load :-/

data/.travis.yml CHANGED

@@ -10,7 +10,7 @@ rvm:
   - 2.1
   - 2.2
   - 2.3.3
-  - 2.4.0
+  - 2.4.1
 ##  - ruby-head
 branches:

data/Gemfile CHANGED

@@ -2,4 +2,3 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in review.gemspec
 gemspec

data/NEWS.ja.md CHANGED

@@ -1,3 +1,85 @@
+# Version 2.4.0
+## 新機能
+* エラーや警告の出力に Ruby 標準の Logger クラスを使うようにしました ([#705])
+* EPUBMaker: 電子書籍ストアで拒絶されることの多い、大きなピクセル数の画像ファイルに対して警告を出すようにしました ([#819])
+* LATEXBuilder: ページ参照のための `@<pageref>` 命令を追加しました ([#836])
+* インライン命令で `{}` で引数を囲む代わりに `| |` あるいは `$ $` で囲むことにより、`}` のエスケープが不要になる、フェンス記法を導入しました ([#876])
+## 非互換の変更
+* LATEXBuilder: 部番号のデフォルト表記をローマ数字にしました ([#837])
+* EPUBMaker: 目次を冒頭ではなく前付の後に置くようにしました ([#840])
+* `imgmath` 有効時に数式画像ファイルを書き出すフォルダを、`images` 直下ではなく `images/_review_math`  としました ([#856])
+* EPUBMaker: 大扉の有無を示す titlepage のデフォルトは null (無) から、PDFMaker と同様に true (有) になりました ([#862])
+* EPUBMaker: テンプレートファイルの `params` を `config` に置き換えました ([#867])
+* 利用者がいないため、EWBBuilder を撤去しました ([#828])
+## バグ修正
+* 見出しが空、あるいはコードブロック内等で誤認識される挙動を修正しました ([#121])
+* TOPBuilder: `//image` で metric パラメータが無視されるのを修正しました。`//indepimage` で metric パラメータがないとエラーになるのを修正しました ([#805])
+* 他章のコラム参照が動作していなかったのを修正しました ([#817])
+* config.yml で `date` の値が空のときに実行時の日付が正しく入るようにしました ([#824])
+* 前付・後付の図・表・リストのキャプションの見出しの前置文字列の定義の誤りを修正しました ([#830])
+* WebMaker の書籍見出しに名前付きパラメータを与えたときの挙動を修正しました ([#831])
+* フォントファイルが不足した一部の環境において、欧文が Type3 形式になってしまう問題を避けるため、lmodern スタイルファイルを読み込むようにしました ([#843])
+* config.yml で `/` を含む見出しがおかしくなる問題を修正しました ([#852])
+* PDFMaker において toclevel の値が正しい効果を表すように修正しました ([#846])
+## 機能強化
+* `//indepimage` で `{ 〜 //}` によるブロック表記を許容するようになりました ([#802])
+* `//indepimage` で画像ファイルが見つからないときに警告を出すようにしました ([#803])
+* LATEXBuilder: `//source` はキャプション引数を許容するようになりました ([#834])
+## ドキュメント
+* `rake pdf` には LaTeX 環境が必要なことを追記しました ([#800])
+* README.md 内のリンクミスを修正しました ([#815])
+* Re:VIEW の各命令の登場パターンを網羅するテストドキュメントを用意しました ([#833])
+* config.yml の titlepage パラメータのコメントを修正しました ([#847])
+* footnotetext の説明を修正しました ([#872])
+## その他
+* rubocop 0.50.0 の指摘に基づき、コーディングルールを統一しました ([#823])
+## コントリビューターのみなさん
+* [@ryota-murakami](https://github.com/ryota-murakami)
+* [@nasum](https://github.com/nasum)
+* [@kokuyouwind](https://github.com/kokuyouwind)
+[#121]: https://github.com/kmuto/review/issues/121
+[#705]: https://github.com/kmuto/review/issues/705
+[#800]: https://github.com/kmuto/review/pull/800
+[#802]: https://github.com/kmuto/review/issues/802
+[#803]: https://github.com/kmuto/review/issues/803
+[#805]: https://github.com/kmuto/review/pull/805
+[#815]: https://github.com/kmuto/review/pull/815
+[#817]: https://github.com/kmuto/review/pull/817
+[#819]: https://github.com/kmuto/review/issues/819
+[#823]: https://github.com/kmuto/review/issues/823
+[#824]: https://github.com/kmuto/review/issues/824
+[#828]: https://github.com/kmuto/review/pull/828
+[#830]: https://github.com/kmuto/review/pull/830
+[#831]: https://github.com/kmuto/review/pull/831
+[#833]: https://github.com/kmuto/review/pull/833
+[#834]: https://github.com/kmuto/review/issues/834
+[#836]: https://github.com/kmuto/review/issues/836
+[#840]: https://github.com/kmuto/review/pull/840
+[#843]: https://github.com/kmuto/review/issues/843
+[#837]: https://github.com/kmuto/review/issues/837
+[#846]: https://github.com/kmuto/review/issues/846
+[#847]: https://github.com/kmuto/review/pull/847
+[#852]: https://github.com/kmuto/review/issues/852
+[#856]: https://github.com/kmuto/review/issues/856
+[#862]: https://github.com/kmuto/review/pull/862
+[#867]: https://github.com/kmuto/review/issues/867
+[#872]: https://github.com/kmuto/review/issues/872
+[#876]: https://github.com/kmuto/review/issues/876
 # Version 2.3.0
 ## 新機能