RubyGems - review - Versions diffs - 1.2.0 → 1.3.0 - Mend

review 1.2.0 → 1.3.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 (78) hide show

checksums.yaml +4 -4
data/.gitignore +36 -0
data/.rubocop.yml +1 -0
data/ChangeLog +102 -0
data/README.rdoc +2 -2
data/bin/review-check +18 -16
data/bin/review-compile +49 -42
data/bin/review-epubmaker +23 -993
data/bin/review-epubmaker-legacy +1024 -0
data/bin/review-index +17 -15
data/bin/review-init +39 -9
data/bin/review-pdfmaker +124 -89
data/bin/review-preproc +16 -14
data/bin/review-vol +17 -15
data/debian/docs +1 -1
data/doc/catalog.rdoc +34 -0
data/doc/format.rdoc +16 -2
data/doc/libepubmaker/{config.yaml → config.yml} +63 -19
data/doc/quickstart.rdoc +1 -1
data/doc/{sample.yaml → sample.yml} +0 -0
data/lib/epubmaker.rb +1 -1
data/lib/epubmaker/content.rb +9 -1
data/lib/epubmaker/epubv2.rb +59 -7
data/lib/epubmaker/epubv3.rb +14 -9
data/lib/epubmaker/producer.rb +68 -27
data/lib/epubmaker/resource.rb +3 -1
data/lib/lineinput.rb +2 -2
data/lib/review/book/base.rb +125 -24
data/lib/review/book/chapter.rb +42 -0
data/lib/review/book/compilable.rb +23 -4
data/lib/review/book/image_finder.rb +64 -0
data/lib/review/book/index.rb +64 -50
data/lib/review/book/page_metric.rb +1 -1
data/lib/review/builder.rb +19 -12
data/lib/review/catalog.rb +47 -0
data/lib/review/compiler.rb +3 -2
data/lib/review/configure.rb +5 -3
data/lib/review/epubmaker.rb +130 -46
data/lib/review/ewbbuilder.rb +27 -31
data/lib/review/extentions/string.rb +4 -4
data/lib/review/htmlbuilder.rb +140 -79
data/lib/review/htmllayout.rb +26 -4
data/lib/review/htmlutils.rb +20 -1
data/lib/review/i18n.rb +5 -2
data/lib/review/{i18n.yaml → i18n.yml} +4 -2
data/lib/review/idgxmlbuilder.rb +65 -39
data/lib/review/latexbuilder.rb +72 -24
data/lib/review/latexutils.rb +3 -1
data/lib/review/makerhelper.rb +8 -2
data/lib/review/preprocessor.rb +20 -20
data/lib/review/review.tex.erb +4 -0
data/lib/review/sec_counter.rb +9 -11
data/lib/review/tocparser.rb +2 -2
data/lib/review/tocprinter.rb +12 -12
data/lib/review/topbuilder.rb +15 -15
data/lib/review/version.rb +1 -1
data/lib/uuid.rb +7 -7
data/review.gemspec +2 -2
data/rubocop-todo.yml +443 -0
data/test/sample-book/src/config.yml +2 -2
data/test/sample-book/src/{main.css → style.css} +0 -0
data/test/test_book.rb +46 -48
data/test/test_book_chapter.rb +25 -13
data/test/test_builder.rb +3 -3
data/test/test_catalog.rb +107 -0
data/test/test_epubmaker.rb +6 -6
data/test/test_htmlbuilder.rb +160 -39
data/test/test_htmlutils.rb +22 -0
data/test/test_i18n.rb +2 -2
data/test/test_idgxmlbuilder.rb +33 -47
data/test/test_image_finder.rb +82 -0
data/test/test_inaobuilder.rb +1 -1
data/test/test_latexbuilder.rb +35 -39
data/test/test_lineinput.rb +2 -2
data/test/test_markdownbuilder.rb +2 -2
data/test/test_topbuilder.rb +39 -23
metadata +23 -14
data/bin/review-epubmaker-ng +0 -23

data/test/test_epubmaker.rb CHANGED

@@ -398,7 +398,7 @@ EOT
 <head>
   <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/>
   <meta http-equiv="Content-Style-Type" content="text/css"/>
-  <meta name="generator" content="EPUBMaker::Producer"/>
+  <meta name="generator" content="Re:VIEW"/>
   <title>Table of Contents</title>
 </head>
 <body>
@@ -430,7 +430,7 @@ EOT
 <head>
   <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/>
   <meta http-equiv="Content-Style-Type" content="text/css"/>
-  <meta name="generator" content="EPUBMaker::Producer"/>
+  <meta name="generator" content="Re:VIEW"/>
   <title>Table of Contents</title>
 </head>
 <body>
@@ -460,7 +460,7 @@ EOT
 <head>
   <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/>
   <meta http-equiv="Content-Style-Type" content="text/css"/>
-  <meta name="generator" content="EPUBMaker::Producer"/>
+  <meta name="generator" content="Re:VIEW"/>
   <title>Sample Book</title>
 </head>
 <body>
@@ -482,7 +482,7 @@ EOT
 <head>
   <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/>
   <meta http-equiv="Content-Style-Type" content="text/css"/>
-  <meta name="generator" content="EPUBMaker::Producer"/>
+  <meta name="generator" content="Re:VIEW"/>
   <title>Sample Book</title>
 </head>
 <body>
@@ -506,7 +506,7 @@ EOT
 <head>
   <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/>
   <meta http-equiv="Content-Style-Type" content="text/css"/>
-  <meta name="generator" content="EPUBMaker::Producer"/>
+  <meta name="generator" content="Re:VIEW"/>
   <title>Colophon</title>
 </head>
 <body>
@@ -538,7 +538,7 @@ EOT
 <head>
   <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/>
   <meta http-equiv="Content-Style-Type" content="text/css"/>
-  <meta name="generator" content="EPUBMaker::Producer"/>
+  <meta name="generator" content="Re:VIEW"/>
   <title>Colophon</title>
 </head>
 <body>

data/test/test_htmlbuilder.rb CHANGED

@@ -11,13 +11,14 @@ class HTMLBuidlerTest < Test::Unit::TestCase
   def setup
     @builder = HTMLBuilder.new()
-    @param = {
+    @config = ReVIEW::Configure.values
+    @config.merge!({
       "secnolevel" => 2,    # for IDGXMLBuilder, HTMLBuilder
       "inencoding" => "UTF-8",
       "outencoding" => "UTF-8",
       "stylesheet" => nil,  # for HTMLBuilder
-    }
-    ReVIEW.book.param = @param
+    })
+    ReVIEW.book.config = @config
     @compiler = ReVIEW::Compiler.new(@builder)
     @chapter = Book::Chapter.new(Book::Base.new(nil), 1, '-', nil, StringIO.new)
     location = Location.new(nil, nil)
@@ -25,7 +26,7 @@ class HTMLBuidlerTest < Test::Unit::TestCase
   end
   def test_xmlns_ops_prefix_epub3
-    ReVIEW.book.param["epubversion"] = 3
+    ReVIEW.book.config["epubversion"] = 3
     assert_equal "epub", @builder.xmlns_ops_prefix
   end
@@ -38,12 +39,81 @@ class HTMLBuidlerTest < Test::Unit::TestCase
     assert_equal %Q|<h1 id="test"><a id="h1"></a>第1章　this is test.</h1>\n|, @builder.raw_result
   end
+  def test_headline_level1_postdef
+    @chapter.instance_eval do
+      def on_POSTDEF?
+        true
+      end
+    end
+    @builder.headline(1,"test","this is test.")
+    assert_equal %Q|<h1 id="test"><a id="h1"></a>付録1　this is test.</h1>\n|, @builder.raw_result
+  end
+  def test_headline_level2_postdef
+    @chapter.instance_eval do
+      def on_POSTDEF?
+        true
+      end
+    end
+    @builder.headline(2,"test","this is test.")
+    assert_equal %Q|\n<h2 id="test"><a id="h1-1"></a>1.1　this is test.</h2>\n|, @builder.raw_result
+  end
+  def test_headline_level1_postdef_roman
+    @chapter.book.config["appendix_format"] = "roman"
+    @chapter.instance_eval do
+      def on_POSTDEF?
+        true
+      end
+    end
+    @builder.headline(1,"test","this is test.")
+    assert_equal %Q|<h1 id="test"><a id="h1"></a>付録I　this is test.</h1>\n|, @builder.raw_result
+  end
+  def test_headline_level2_postdef_roman
+    @chapter.book.config["appendix_format"] = "roman"
+    @chapter.instance_eval do
+      def on_POSTDEF?
+        true
+      end
+    end
+    @builder.headline(2,"test","this is test.")
+    assert_equal %Q|\n<h2 id="test"><a id="h1-1"></a>I.1　this is test.</h2>\n|, @builder.raw_result
+  end
+  def test_headline_level1_postdef_alpha
+    @chapter.book.config["appendix_format"] = "alpha"
+    @chapter.instance_eval do
+      def on_POSTDEF?
+        true
+      end
+    end
+    @builder.headline(1,"test","this is test.")
+    assert_equal %Q|<h1 id="test"><a id="h1"></a>付録A　this is test.</h1>\n|, @builder.raw_result
+  end
+  def test_headline_level2_postdef_alpha
+    @chapter.book.config["appendix_format"] = "alpha"
+    @chapter.instance_eval do
+      def on_POSTDEF?
+        true
+      end
+    end
+    @builder.headline(2,"test","this is test.")
+    assert_equal %Q|\n<h2 id="test"><a id="h1-1"></a>A.1　this is test.</h2>\n|, @builder.raw_result
+  end
   def test_headline_level1_without_secno
-    ReVIEW.book.param["secnolevel"] = 0
+    ReVIEW.book.config["secnolevel"] = 0
     @builder.headline(1,"test","this is test.")
     assert_equal %Q|<h1 id="test"><a id="h1"></a>this is test.</h1>\n|, @builder.raw_result
   end
+  def test_headline_level1_with_tricky_id
+    @builder.headline(1,"123 あ_;","this is test.")
+    assert_equal %Q|<h1 id="id_123-_E3_81_82___3B"><a id="h1"></a>第1章　this is test.</h1>\n|, @builder.raw_result
+  end
   def test_headline_level1_with_inlinetag
     @builder.headline(1,"test","this @<b>{is} test.<&\">")
     assert_equal %Q|<h1 id="test"><a id="h1"></a>第1章　this <b>is</b> test.&lt;&amp;&quot;&gt;</h1>\n|, @builder.raw_result
@@ -60,7 +130,7 @@ class HTMLBuidlerTest < Test::Unit::TestCase
   end
   def test_headline_level3_with_secno
-    ReVIEW.book.param["secnolevel"] = 3
+    ReVIEW.book.config["secnolevel"] = 3
     @builder.headline(3,"test","this is test.")
     assert_equal %Q|\n<h3 id="test"><a id="h1-0-1"></a>1.0.1　this is test.</h3>\n|, @builder.raw_result
   end
@@ -70,6 +140,11 @@ class HTMLBuidlerTest < Test::Unit::TestCase
     assert_equal %Q|<a id="label_test"></a>\n|, @builder.raw_result
   end
+  def test_label_with_tricky_id
+    @builder.label("123 あ_;")
+    assert_equal %Q|<a id="id_123-_E3_81_82___3B"></a>\n|, @builder.raw_result
+  end
   def test_href
     ret = @builder.compile_href("http://github.com", "GitHub")
     assert_equal %Q|<a href="http://github.com" class="link">GitHub</a>|, ret
@@ -146,11 +221,11 @@ class HTMLBuidlerTest < Test::Unit::TestCase
       Book::HeadlineIndex.new(items, self)
     end
-    @param["secnolevel"] = 2
+    @config["secnolevel"] = 2
     ret = @builder.compile_inline("test @<hd>{chap1|test} test2")
     assert_equal %Q|test 「te_st」 test2|, ret
-    @param["secnolevel"] = 3
+    @config["secnolevel"] = 3
     ret = @builder.compile_inline("test @<hd>{chap1|test} test2")
     assert_equal %Q|test 「1.1.1 te_st」 test2|, ret
   end
@@ -175,6 +250,19 @@ class HTMLBuidlerTest < Test::Unit::TestCase
     assert_equal %Q|<a target='外部参照&lt;&gt;&amp;'>「●●　外部参照&lt;&gt;&amp;」</a>|, ret
   end
+  def test_inline_mathml
+    begin
+      require 'math_ml'
+      require "math_ml/symbol/character_reference"
+    rescue LoadError
+      return true
+    end
+    @config["mathml"] = true
+    ret = @builder.compile_inline("@<m>{\\frac{-b \\pm \\sqrt{b^2 - 4ac\\}\\}{2a\\}}")
+    @config["mathml"] = nil
+    assert_equal "<span class=\"equation\"><math xmlns='http://www.w3.org/1998/Math/MathML' display='inline'><mfrac><mrow><mo stretchy='false'>-</mo><mi>b</mi><mo stretchy='false'>&#xb1;</mo><msqrt><mrow><msup><mi>b</mi><mn>2</mn></msup><mo stretchy='false'>-</mo><mn>4</mn><mi>a</mi><mi>c</mi></mrow></msqrt></mrow><mrow><mn>2</mn><mi>a</mi></mrow></mfrac></math></span>", ret
+  end
   def test_quote
     lines = ["foo", "bar", "","buz"]
     @builder.quote(lines)
@@ -206,39 +294,50 @@ class HTMLBuidlerTest < Test::Unit::TestCase
   def test_image
     def @chapter.image(id)
       item = Book::ImageIndex::Item.new("sampleimg",1)
-      item.instance_eval{@pathes=["./images/chap1-sampleimg.png"]}
+      item.instance_eval{@path="./images/chap1-sampleimg.png"}
       item
     end
     @builder.image_image("sampleimg","sample photo",nil)
-    assert_equal %Q|<div class="image">\n<img src="images/chap1-sampleimg.png" alt="sample photo" />\n<p class="caption">\n図1.1: sample photo\n</p>\n</div>\n|, @builder.raw_result
+    assert_equal %Q|<div id="sampleimg" class="image">\n<img src="images/chap1-sampleimg.png" alt="sample photo" />\n<p class="caption">\n図1.1: sample photo\n</p>\n</div>\n|, @builder.raw_result
   end
   def test_image_with_metric
     def @chapter.image(id)
       item = Book::ImageIndex::Item.new("sampleimg",1)
-      item.instance_eval{@pathes=["./images/chap1-sampleimg.png"]}
+      item.instance_eval{@path="./images/chap1-sampleimg.png"}
       item
     end
     @builder.image_image("sampleimg","sample photo","scale=1.2")
-    assert_equal %Q|<div class="image">\n<img src="images/chap1-sampleimg.png" alt="sample photo" width="120%" />\n<p class="caption">\n図1.1: sample photo\n</p>\n</div>\n|, @builder.raw_result
+    assert_equal %Q|<div id="sampleimg" class="image">\n<img src="images/chap1-sampleimg.png" alt="sample photo" width="120%" />\n<p class="caption">\n図1.1: sample photo\n</p>\n</div>\n|, @builder.raw_result
   end
   def test_image_with_metric2
     def @chapter.image(id)
       item = Book::ImageIndex::Item.new("sampleimg",1)
-      item.instance_eval{@pathes=["./images/chap1-sampleimg.png"]}
+      item.instance_eval{@path="./images/chap1-sampleimg.png"}
       item
     end
     @builder.image_image("sampleimg","sample photo","scale=1.2,html::class=sample,latex::ignore=params")
-    assert_equal %Q|<div class="image">\n<img src="images/chap1-sampleimg.png" alt="sample photo" width="120%" class="sample" />\n<p class="caption">\n図1.1: sample photo\n</p>\n</div>\n|, @builder.raw_result
+    assert_equal %Q|<div id="sampleimg" class="image">\n<img src="images/chap1-sampleimg.png" alt="sample photo" width="120%" class="sample" />\n<p class="caption">\n図1.1: sample photo\n</p>\n</div>\n|, @builder.raw_result
+  end
+  def test_image_with_tricky_id
+    def @chapter.image(id)
+      item = Book::ImageIndex::Item.new("123 あ_;",1)
+      item.instance_eval{@path="./images/chap1-123 あ_;.png"}
+      item
+    end
+    @builder.image_image("123 あ_;","sample photo",nil)
+    assert_equal %Q|<div id="id_123-_E3_81_82___3B" class="image">\n<img src="images/chap1-123 あ_;.png" alt="sample photo" />\n<p class="caption">\n図1.1: sample photo\n</p>\n</div>\n|, @builder.raw_result
   end
   def test_indepimage
     def @chapter.image(id)
       item = Book::ImageIndex::Item.new("sampleimg",1)
-      item.instance_eval{@pathes=["./images/chap1-sampleimg.png"]}
+      item.instance_eval{@path="./images/chap1-sampleimg.png"}
       item
     end
@@ -249,7 +348,7 @@ class HTMLBuidlerTest < Test::Unit::TestCase
   def test_indepimage_without_caption
     def @chapter.image(id)
       item = Book::ImageIndex::Item.new("sampleimg",1)
-      item.instance_eval{@pathes=["./images/chap1-sampleimg.png"]}
+      item.instance_eval{@path="./images/chap1-sampleimg.png"}
       item
     end
@@ -260,7 +359,7 @@ class HTMLBuidlerTest < Test::Unit::TestCase
   def test_indepimage_with_metric
     def @chapter.image(id)
       item = Book::ImageIndex::Item.new("sampleimg",1)
-      item.instance_eval{@pathes=["./images/chap1-sampleimg.png"]}
+      item.instance_eval{@path="./images/chap1-sampleimg.png"}
       item
     end
@@ -271,7 +370,7 @@ class HTMLBuidlerTest < Test::Unit::TestCase
   def test_indepimage_with_metric2
     def @chapter.image(id)
       item = Book::ImageIndex::Item.new("sampleimg",1)
-      item.instance_eval{@pathes=["./images/chap1-sampleimg.png"]}
+      item.instance_eval{@path="./images/chap1-sampleimg.png"}
       item
     end
@@ -282,7 +381,7 @@ class HTMLBuidlerTest < Test::Unit::TestCase
   def test_indepimage_without_caption_but_with_metric
     def @chapter.image(id)
       item = Book::ImageIndex::Item.new("sampleimg",1)
-      item.instance_eval{@pathes=["./images/chap1-sampleimg.png"]}
+      item.instance_eval{@path="./images/chap1-sampleimg.png"}
       item
     end
@@ -308,7 +407,7 @@ class HTMLBuidlerTest < Test::Unit::TestCase
     rescue LoadError
       return true
     end
-    ReVIEW.book.param["pygments"] = true
+    ReVIEW.book.config["pygments"] = true
     @builder.list(["test1", "test1.5", "", "test<i>2</i>"], "samplelist", "this is @<b>{test}<&>_")
     assert_equal %Q|<div class="caption-code">\n<p class="caption">リスト1.1: this is <b>test</b>&lt;&amp;&gt;_</p>\n<pre class="list">test1\ntest1.5\n\ntest<span style="color: #008000; font-weight: bold">&lt;i&gt;</span>2<span style="color: #008000; font-weight: bold">&lt;/i&gt;</span>\n</pre>\n</div>\n|, @builder.raw_result
@@ -438,6 +537,31 @@ EOS
     end
   end
+  def test_column_ref
+    review =<<-EOS
+===[column]{foo} test
+inside column
+=== next level
+this is @<column>{foo}.
+EOS
+    expect =<<-EOS
+<div class="column">
+<h3 id="foo"><a id="column-1"></a>test</h3>
+<p>inside column</p>
+</div>
+<h3><a id="h1-0-1"></a>next level</h3>
+<p>this is test.</p>
+EOS
+    assert_equal expect, column_helper(review)
+  end
   def test_ul
     src =<<-EOS
   * AAA
@@ -620,44 +744,31 @@ EOS
   def test_block_raw0
     @builder.raw("<>!\"\\n& ")
-    expect =<<-EOS
-<>!"
-&
-EOS
+    expect = %Q(<>!\"\n& )
     assert_equal expect.chomp, @builder.raw_result
   end
   def test_block_raw1
     @builder.raw("|html|<>!\"\\n& ")
-    expect =<<-EOS
-<>!"
-&
-EOS
+    expect = %Q(<>!\"\n& )
     assert_equal expect.chomp, @builder.raw_result
   end
   def test_block_raw2
     @builder.raw("|html, latex|<>!\"\\n& ")
-    expect =<<-EOS
-<>!\"
-&
-EOS
+    expect = %Q(<>!\"\n& )
     assert_equal expect.chomp, @builder.raw_result
   end
   def test_block_raw3
     @builder.raw("|latex, idgxml|<>!\"\\n& ")
-    expect =<<-EOS
-EOS
+    expect = ''
     assert_equal expect.chomp, @builder.raw_result
   end
   def test_block_raw4
     @builder.raw("|html <>!\"\\n& ")
-    expect =<<-EOS
-|html <>!\"
-&
-EOS
+    expect = %Q(|html <>!\"\n& )
     assert_equal expect.chomp, @builder.raw_result
   end
@@ -666,7 +777,17 @@ EOS
     @chapter.instance_eval{@footnote_index=fn}
     @builder.footnote("foo",'bar\\a\\$buz')
     expect =<<-'EOS'
-<div class="footnote"><p class="footnote">[<a id="fn-foo">*1</a>] bar\a\$buz</p></div>
+<div class="footnote" id="fn-foo"><p class="footnote">[<a href="#fnb-foo">*1</a>] bar\a\$buz</p></div>
+EOS
+    assert_equal expect, @builder.raw_result
+  end
+  def test_inline_fn_with_tricky_id
+    fn = Book::FootnoteIndex.parse(['//footnote[123 あ_;][bar\\a\\$buz]'])
+    @chapter.instance_eval{@footnote_index=fn}
+    @builder.footnote("123 あ_;",'bar\\a\\$buz')
+    expect =<<-'EOS'
+<div class="footnote" id="fn-id_123-_E3_81_82___3B"><p class="footnote">[<a href="#fnb-id_123-_E3_81_82___3B">*1</a>] bar\a\$buz</p></div>
 EOS
     assert_equal expect, @builder.raw_result
   end

data/test/test_htmlutils.rb CHANGED

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 require 'test_helper'
 require 'review/htmlutils'
@@ -25,4 +26,25 @@ class HTMLUtilsTest < Test::Unit::TestCase
   def test_strip_html
     assert_equal 'thisistest.', strip_html('<h3>this<b>is</b>test</h3>.')
   end
+  def test_escape_comment
+    assert_equal '<', escape_comment('<')
+    assert_equal '>', escape_comment('>')
+    assert_equal '&', escape_comment('&')
+    assert_equal '&#45;', escape_comment('-')
+    assert_equal '&#45;&#45;', escape_comment('--')
+  end
+  def test_normalize_id
+    assert_equal 'abcxyz', normalize_id('abcxyz')
+    assert_equal 'ABCXYZ', normalize_id('ABCXYZ')
+    assert_equal 'abc0123', normalize_id('abc0123')
+    assert_equal 'a-b-c_x.y.z', normalize_id('a-b-c_x.y.z')
+    assert_equal 'id_a_3Ab_3Ac', normalize_id('a:b:c')
+    assert_equal 'id_0123a-b-c_x.y.z', normalize_id('0123a-b-c_x.y.z')
+    assert_equal 'id_.', normalize_id('.')
+    assert_equal 'id__E3_81_82', normalize_id('あ')
+    assert_equal 'id_-___3B', normalize_id(' _;')
+  end
 end

data/test/test_i18n.rb CHANGED

@@ -49,13 +49,13 @@ class I18nTest < Test::Unit::TestCase
   def _setup_htmlbuilder
     I18n.i18n "en"
     @builder = HTMLBuilder.new()
-    @param = {
+    @config = {
       "secnolevel" => 2,    # for IDGXMLBuilder, HTMLBuilder
       "inencoding" => "UTF-8",
       "outencoding" => "UTF-8",
       "stylesheet" => nil,  # for HTMLBuilder
     }
-    ReVIEW.book.param = @param
+    ReVIEW.book.config = @config
     @compiler = ReVIEW::Compiler.new(@builder)
     @chapter = Book::Chapter.new(Book::Base.new(nil), 1, '-', nil, StringIO.new)
     location = Location.new(nil, nil)