review 5.4.0 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ad3162f29bf4de92283c57885f6b590ba44a6cb27c2d34a206c09b3609bf3d4
-  data.tar.gz: eb217e39616f9ec506079906643d47a73533ec3f19759f92bdb01b2bf4e30a68
+  metadata.gz: a1f097d4affd13c0fc3522a4b8a95f7cc293c6ae1f5096060d8cb3a27e55bfe0
+  data.tar.gz: 3690f0b732e216aca3a2a267f16b15f838d86facbb3615d07f70eae83223054e
 SHA512:
-  metadata.gz: 51ced5b39f84d352092f335e43f621e75d7dc2a096f7ce1f39aa62715e5bd858aafde903a96a3586980c6064909a8096b7405be6e851ff5c592ea68b04a1830b
-  data.tar.gz: 958233d45fec5df7643ead4e66bf4998494e30772e312c20f8f9348df1f863ff393284df8adb30fe35b457fa3d8e80a384f4bef3b1b83b5b53a54bfef1c4d280
+  metadata.gz: 99517b9b71d5d8adf7c89cfc9c2f09d9a53efdffccadef5f57881e0e205d1b6415f1d9e5bdd9ad0847787b5176a7b4da5a00150752de880a31145cc1224e8cd8
+  data.tar.gz: fbf5fcde5e37bc49ad32cc0f1ac96cfca2b88f35f2067c16ce2f3a35758426ea50c5eaf7ef91eaad174f7bfc07bec05f254106cbf969152d1a6fd7b7fe79a197

data/NEWS.ja.md

@@ -1,3 +1,18 @@
+# Version 5.5.0
+## 新機能
+* 節や項を参照するインライン命令として、 `@<secref>` , `@<sec>` , `@<sectitle>` を追加しました。`@<secref>` は節や項の番号+タイトルを含むテキスト（ `@<hd>` と同じ）、 `@<sec>` は節や項の番号のみ、`@<sectitle>` はタイトルのみに展開されます ([#1809])
+## バグ修正
+* テストエラーを修正しました ([#1804])
+* review-update コマンドがエラーになるのを修正しました ([#1807])
+
+## その他
+* rexml がバンドル gem 扱いになったので、gemspec に追加しました ([#1808])
+
+[#1804]: https://github.com/kmuto/review/pull/1804
+[#1807]: https://github.com/kmuto/review/pull/1807
+[#1808]: https://github.com/kmuto/review/pull/1808
+[#1809]: https://github.com/kmuto/review/issues/1809
+
 # Version 5.4.0
 ## 新機能
 * Re:VIEW に関する質問の受け付けに対応する [GitHub Discussions](https://github.com/kmuto/review/discussions) を開始しました

data/NEWS.md

@@ -1,3 +1,19 @@
+# Version 5.5.0
+## New Features
+* introduced `@<secref>`, `@<sec>`, and `@<sectitle>` as inline op to refer sections ([#1809])
+
+## Bug Fixes
+* fixed test error ([#1804])
+* fixed an error of review-update ([#1807])
+
+## Others
+* added rexml to gemspec ([#1808])
+
+[#1804]: https://github.com/kmuto/review/pull/1804
+[#1807]: https://github.com/kmuto/review/pull/1807
+[#1808]: https://github.com/kmuto/review/pull/1808
+[#1809]: https://github.com/kmuto/review/issues/1809
+
 # Version 5.4.0
 ## New Features
 * [GitHub Discussions](https://github.com/kmuto/review/discussions) has been opened to answer questions about Re:VIEW

data/doc/format.ja.md

@@ -2,7 +2,7 @@
 
 Re:VIEW フォーマットの文法について解説します。Re:VIEW フォーマットはアスキー社（現カドカワ）の EWB を基本としながら、一部に RD や各種 Wiki の文法を取り入れて簡素化しています。
 
-このドキュメントは、Re:VIEW 5.3 に基づいています。
+このドキュメントは、Re:VIEW 5.5 に基づいています。
 
 ## 段落
 
@@ -796,7 +796,7 @@ imgmath_options:
 @<hd>{preface|はじめに|まずは}
 ```
 
-参照先にラベルが設定されている場合は、見出しの代わりに、ラベルで参照します。
+参照先にラベルが設定されている場合は、見出しの代わりに、ラベルで参照します。複雑な階層をとるときにはラベルを使うことを推奨します。
 
 ```
 =={hajimeni} はじめに
@@ -806,6 +806,10 @@ imgmath_options:
 @<hd>{hajimeni|まずは}
 ```
 
+* `@<hd>{見出しまたはラベル}` あるいは `@<secref>{見出しまたはラベル}` : 『「1.1 まずは」』のように、節項番号とタイトルを含むテキストに置換されます。
+* `@<sec>{見出しまたはラベル}` : 「1.1」のような節項番号に置換されます。番号が付かない箇所の場合はエラーになります。
+* `@<sectitle>{見出しまたはラベル}` : 「まずは」のように、節項のタイトル部に置換されます。
+
 ### コラム見出し参照
 
 コラムの見出しの参照は、インライン命令 `@<column>` を使います。

data/lib/review/builder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2002-2021 Minero Aoki, Kenshi Muto
+# Copyright (c) 2002-2022 Minero Aoki, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -450,6 +450,27 @@ module ReVIEW
       app_error "unknown headline: #{id}"
     end
 
+    alias_method :inline_secref, :inline_hd
+
+    def inline_sec(id)
+      chapter, id = extract_chapter_id(id)
+      n = chapter.headline_index.number(id)
+      if n.present? && chapter.number && over_secnolevel?(n)
+        n
+      else
+        app_error "the target headline doesn't have a number: #{id}"
+      end
+    rescue KeyError
+      app_error "unknown headline: #{id}"
+    end
+
+    def inline_sectitle(id)
+      chapter, id = extract_chapter_id(id)
+      compile_inline(chapter.headline(id).caption)
+    rescue KeyError
+      app_error "unknown headline: #{id}"
+    end
+
     def inline_column(id)
       m = /\A([^|]+)\|(.+)/.match(id)
       if m && m[1]

data/lib/review/compiler.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2009-2021 Minero Aoki, Kenshi Muto
+# Copyright (c) 2009-2022 Minero Aoki, Kenshi Muto
 # Copyright (c) 2002-2007 Minero Aoki
 #
 # This program is free software.
@@ -232,6 +232,9 @@ module ReVIEW
     definline :code
     definline :bib
     definline :hd
+    definline :secref
+    definline :sec
+    definline :sectitle
     definline :href
     definline :recipe
     definline :column

data/lib/review/htmlbuilder.rb

@@ -1112,6 +1112,31 @@ EOS
       app_error "unknown headline: #{id}"
     end
 
+    def inline_sec(id)
+      if @book.config['chapterlink']
+        chap, id2 = extract_chapter_id(id)
+        n = chap.headline_index.number(id2)
+        anchor = 'h' + n.tr('.', '-')
+        %Q(<a href="#{chap.id}#{extname}##{anchor}">#{super(id)}</a>)
+      else
+        super(id)
+      end
+    rescue KeyError
+      app_error "unknown headline: #{id}"
+    end
+
+    def inline_sectitle(id)
+      if @book.config['chapterlink']
+        chap, id2 = extract_chapter_id(id)
+        anchor = 'h' + chap.headline_index.number(id2).tr('.', '-')
+        %Q(<a href="#{chap.id}#{extname}##{anchor}">#{super(id)}</a>)
+      else
+        super(id)
+      end
+    rescue KeyError
+      app_error "unknown headline: #{id}"
+    end
+
     def column_label(id, chapter = @chapter)
       num = chapter.column(id).number
       "column-#{num}"

data/lib/review/index_builder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2021 Minero Aoki, Kenshi Muto, Masayoshi Takahashi,
+# Copyright (c) 2008-2022 Minero Aoki, Kenshi Muto, Masayoshi Takahashi,
 #                         KADO Masanori
 #
 # This program is free software.
@@ -517,6 +517,18 @@ module ReVIEW
       ''
     end
 
+    def inline_secref(_id)
+      ''
+    end
+
+    def inline_sec(_id)
+      ''
+    end
+
+    def inline_sectitle(_id)
+      ''
+    end
+
     def inline_bib(_id)
       ''
     end

data/lib/review/latexbuilder.rb

@@ -1,6 +1,6 @@
 # Copyright (c) 2002-2007 Minero Aoki
 #               2008-2009 Minero Aoki, Kenshi Muto
-#               2010-2021 Minero Aoki, Kenshi Muto, TAKAHASHI Masayoshi
+#               2010-2022 Minero Aoki, Kenshi Muto, TAKAHASHI Masayoshi
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -1290,6 +1290,28 @@ module ReVIEW
       end
     end
 
+    def inline_sec(id)
+      if @book.config['chapterlink']
+        n = super(id)
+        anchor = n.tr('.', '-')
+        macro('reviewsecref', n, sec_label(anchor))
+      else
+        super(id)
+      end
+    rescue KeyError
+      app_error "unknown headline: #{id}"
+    end
+
+    def inline_sectitle(id)
+      if @book.config['chapterlink']
+        chap, id2 = extract_chapter_id(id)
+        anchor = chap.headline_index.number(id2).tr('.', '-')
+        macro('reviewsecref', super(id), sec_label(anchor))
+      else
+        super(id)
+      end
+    end
+
     def inline_column_chap(chapter, id)
       macro('reviewcolumnref',
             I18n.t('column', compile_inline(chapter.column(id).caption)),

data/lib/review/plaintextbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2018-2021 Kenshi Muto
+# Copyright (c) 2018-2022 Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of

data/lib/review/version.rb

@@ -1,3 +1,3 @@
 module ReVIEW
-  VERSION = '5.4.0'.freeze
+  VERSION = '5.5.0'.freeze
 end

data/lib/review/yamlloader.rb

@@ -1,4 +1,5 @@
 require 'yaml'
+require 'date'
 
 module ReVIEW
   class YAMLLoader

data/review.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_dependency('image_size')
+  gem.add_dependency('rexml')
   gem.add_dependency('rouge')
   gem.add_dependency('rubyzip')
   gem.add_dependency('tty-logger')

data/samples/syntax-book/ch02.re

@@ -332,10 +332,16 @@ a_{m1} & \cdots & a_{mn}
  * 章題：@<title>{ch01}、@<title>{part2}、@<title>{appA}、@<title>{bib}
  * 章番号+題：@<chapref>{ch02}、@<chapref>{part2}、@<chapref>{appA}、@<chapref>{bib}
 
-節や項への参照はhdを使います。
+節や項への参照はhdまたはsecを使います。
 
  * @<hd>{ch02|ブロック命令}の@<hd>{ch02|ブロック命令|図}
  * @<hd>{ch02|crossref}
+ * @<secref>{ch02|ブロック命令}の@<secref>{ch02|ブロック命令|図}
+ * @<secref>{ch02|crossref}
+ * @<sec>{ch02|ブロック命令}の@<sec>{ch02|ブロック命令|図}
+ * @<sec>{ch02|crossref}
+ * @<sectitle>{ch02|ブロック命令}の@<sectitle>{ch02|ブロック命令|図}
+ * @<sectitle>{ch02|crossref}
  * コラム参照 @<column>{ch03|column2}
 
 他章への図表リスト参照の例です（@<list>{pre01|main1}、@<img>{pre01|fractal}、@<table>{pre01|tbl1}、@<list>{appA|lista-1}、@<img>{appA|puzzle}、@<table>{appA|taba-1}）。

data/test/assets/syntax_book_index_detail.txt

@@ -26,7 +26,7 @@
 -----------------------------
    169C     2L   0.2P  第II部　部見出し■□■□■□■□■□■□■□■□■□■□■□■□■□■□■□■□■□■□
 =============================
-  5796C   180L    11P  ch02
+  5858C   186L    11P  ch02
 -----------------------------
     52C     1L   0.0P  第2章　長い章見出し■□■□■□■□■□■□■□■□■□■□■□■□■□■□■□■□■□■□■□■□■□
     10C     1L   0.0P    2.1　ブロック命令
@@ -39,7 +39,7 @@
     11C     1L   0.0P    2.4　インライン命令
    967C    17L   1.3P      2.4.1　書体
     74C     1L   0.0P      2.4.2　見出し内 BOLD,ITALIC,TT,STRONG,EM,CODE,TTB,TTI,AMI,BOU,KW,UNDERLINE,INS、
-   797C    22L   1.3P      2.4.3　参照
+   859C    28L   1.6P      2.4.3　参照
     39C     2L   0.1P      2.4.4　参考文献
    194C     3L   0.3P      2.4.5　索引
     34C     3L   0.1P        2.4.5.1　後注

data/test/test_htmlbuilder.rb

@@ -372,6 +372,40 @@ EOS
     end
   end
 
+  def test_inline_sec
+    def @chapter.headline_index
+      item = Book::Index::Item.new('chap1|test', [1, 1], 'te_st<>')
+      idx = Book::HeadlineIndex.new(self)
+      idx.add_item(item)
+      idx
+    end
+
+    @config['secnolevel'] = 3
+    actual = compile_inline('test @<secref>{test}')
+    assert_equal 'test <a href="-.html#h1-1-1">「1.1.1 te_st&lt;&gt;」</a>', actual
+    actual = compile_inline('test @<sectitle>{test}')
+    assert_equal 'test <a href="-.html#h1-1-1">te_st&lt;&gt;</a>', actual
+    actual = compile_inline('test @<sec>{test}')
+    assert_equal 'test <a href="-.html#h1-1-1">1.1.1</a>', actual
+
+    @config['secnolevel'] = 2
+    actual = compile_inline('test @<secref>{test}')
+    assert_equal 'test <a href="-.html#h1-1-1">「te_st&lt;&gt;」</a>', actual
+    actual = compile_inline('test @<sectitle>{test}')
+    assert_equal 'test <a href="-.html#h1-1-1">te_st&lt;&gt;</a>', actual
+    assert_raises(ReVIEW::ApplicationError) { compile_block('test @<sec>{test}') }
+    assert_match(/the target headline doesn't have a number/, @log_io.string)
+
+    @config['chapterlink'] = nil
+    @config['secnolevel'] = 3
+    actual = compile_inline('test @<secref>{test}')
+    assert_equal 'test 「1.1.1 te_st&lt;&gt;」', actual
+    actual = compile_inline('test @<sectitle>{test}')
+    assert_equal 'test te_st&lt;&gt;', actual
+    actual = compile_inline('test @<sec>{test}')
+    assert_equal 'test 1.1.1', actual
+  end
+
   def test_inline_uchar
     actual = compile_inline('test @<uchar>{2460} test2')
     assert_equal 'test &#x2460; test2', actual

data/test/test_latexbuilder.rb

@@ -288,6 +288,40 @@ EOS
     assert_equal 'test 「1.1.1 te\\textunderscore{}st」 test2', actual
   end
 
+  def test_inline_sec
+    def @chapter.headline_index
+      item = Book::Index::Item.new('chap1|test', [1, 1], 'te_st<>')
+      idx = Book::HeadlineIndex.new(self)
+      idx.add_item(item)
+      idx
+    end
+
+    @config['secnolevel'] = 3
+    actual = compile_inline('test @<secref>{test}')
+    assert_equal 'test \reviewsecref{「1.1.1 te\textunderscore{}st\textless{}\textgreater{}」}{sec:1-1-1}', actual
+    actual = compile_inline('test @<sectitle>{test}')
+    assert_equal 'test \reviewsecref{te\textunderscore{}st\textless{}\textgreater{}}{sec:1-1-1}', actual
+    actual = compile_inline('test @<sec>{test}')
+    assert_equal 'test \reviewsecref{1.1.1}{sec:1-1-1}', actual
+
+    @config['secnolevel'] = 2
+    actual = compile_inline('test @<secref>{test}')
+    assert_equal 'test \reviewsecref{「te\textunderscore{}st\textless{}\textgreater{}」}{sec:1-1-1}', actual
+    actual = compile_inline('test @<sectitle>{test}')
+    assert_equal 'test \reviewsecref{te\textunderscore{}st\textless{}\textgreater{}}{sec:1-1-1}', actual
+    assert_raises(ReVIEW::ApplicationError) { compile_block('test @<sec>{test}') }
+    assert_match(/the target headline doesn't have a number/, @log_io.string)
+
+    @config['chapterlink'] = nil
+    @config['secnolevel'] = 3
+    actual = compile_inline('test @<secref>{test}')
+    assert_equal 'test 「1.1.1 te\textunderscore{}st\textless{}\textgreater{}」', actual
+    actual = compile_inline('test @<sectitle>{test}')
+    assert_equal 'test te\textunderscore{}st\textless{}\textgreater{}', actual
+    actual = compile_inline('test @<sec>{test}')
+    assert_equal 'test 1.1.1', actual
+  end
+
   def test_inline_pageref
     actual = compile_inline('test p.@<pageref>{p1}')
     assert_equal 'test p.\pageref{p1}', actual

data/test/test_markdownbuilder.rb

@@ -148,6 +148,38 @@ EOS
     assert_equal 'test 「1.1.1 te_st」 test2', actual
   end
 
+  def test_inline_sec
+    def @chapter.headline_index
+      item = Book::Index::Item.new('chap1|test', [1, 1], 'te_st<>')
+      idx = Book::HeadlineIndex.new(self)
+      idx.add_item(item)
+      idx
+    end
+
+    @config['secnolevel'] = 3
+    actual = compile_inline('test @<secref>{test}')
+    assert_equal 'test <a href="#h1-1-1">「1.1.1 te_st<>」</a>', actual
+    actual = compile_inline('test @<sectitle>{test}')
+    assert_equal 'test te_st<>', actual
+    actual = compile_inline('test @<sec>{test}')
+    assert_equal 'test 1.1.1', actual
+
+    @config['secnolevel'] = 2
+    actual = compile_inline('test @<secref>{test}')
+    assert_equal 'test <a href="#h1-1-1">「te_st<>」</a>', actual
+    actual = compile_inline('test @<sectitle>{test}')
+    assert_equal 'test te_st<>', actual
+    assert_raises(ReVIEW::ApplicationError) { compile_block('test @<sec>{test}') }
+    @config['chapterlink'] = nil
+    @config['secnolevel'] = 3
+    actual = compile_inline('test @<secref>{test}')
+    assert_equal 'test 「1.1.1 te_st<>」', actual
+    actual = compile_inline('test @<sectitle>{test}')
+    assert_equal 'test te_st<>', actual
+    actual = compile_inline('test @<sec>{test}')
+    assert_equal 'test 1.1.1', actual
+  end
+
   def test_ul_nest1
     src = <<-EOS
   * AAA

data/test/test_plaintextbuilder.rb

@@ -67,6 +67,31 @@ class PLAINTEXTBuidlerTest < Test::Unit::TestCase
     assert_equal 'http://github.com', actual
   end
 
+  def test_inline_sec
+    def @chapter.headline_index
+      item = Book::Index::Item.new('chap1|test', [1, 1], 'te_st<>')
+      idx = Book::HeadlineIndex.new(self)
+      idx.add_item(item)
+      idx
+    end
+
+    @config['secnolevel'] = 3
+    actual = compile_inline('test @<secref>{test}')
+    assert_equal 'test 「1.1.1 te_st<>」', actual
+    actual = compile_inline('test @<sectitle>{test}')
+    assert_equal 'test te_st<>', actual
+    actual = compile_inline('test @<sec>{test}')
+    assert_equal 'test 1.1.1', actual
+
+    @config['secnolevel'] = 2
+    actual = compile_inline('test @<secref>{test}')
+    assert_equal 'test 「te_st<>」', actual
+    actual = compile_inline('test @<sectitle>{test}')
+    assert_equal 'test te_st<>', actual
+    assert_raises(ReVIEW::ApplicationError) { compile_block('test @<sec>{test}') }
+    assert_match(/the target headline doesn't have a number/, @log_io.string)
+  end
+
   def test_inline_raw
     actual = compile_inline('@<raw>{@<tt>{inline\}}')
     assert_equal '@<tt>{inline}', actual

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: review
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 5.5.0
 platform: ruby
 authors:
 - kmuto
 - takahashim
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-27 00:00:00.000000000 Z
+date: 2022-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: image_size
@@ -25,6 +25,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rouge
   requirement: !ruby/object:Gem::Requirement
@@ -626,7 +640,7 @@ licenses:
 - LGPL
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -641,8 +655,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: 'Re:VIEW: a easy-to-use digital publishing system'
 test_files: