review 5.0.0 → 5.3.0

data/test/test_preprocessor.rb

@@ -1,9 +1,196 @@
 require 'test_helper'
 require 'review/preprocessor'
 require 'stringio'
+require 'book_test_helper'
 
 class PreprocessorTest < Test::Unit::TestCase
   include ReVIEW
+  include BookTestHelper
 
-  ## TODO: add tests
+  def test_mapfile
+    preproc = ReVIEW::Preprocessor.new({})
+
+    ch01_re = <<-'REFILE'
+= test1
+
+//list[hello.rb.1][hello.re]{
+#@mapfile(hello.rb)
+#@end
+//}
+REFILE
+
+    hello_rb = <<-'RBFILE'
+#!/usr/bin/env ruby
+
+class Hello
+  def hello(name)
+    print "hello, #{name}!\n"
+  end
+end
+
+if __FILE__ == $0
+  Hello.new.hello("world")
+end
+RBFILE
+
+    expected = <<-'EXPECTED'
+= test1
+
+//list[hello.rb.1][hello.re]{
+#@mapfile(hello.rb)
+#!/usr/bin/env ruby
+
+class Hello
+  def hello(name)
+    print "hello, #{name}!\n"
+  end
+end
+
+if __FILE__ == $0
+  Hello.new.hello("world")
+end
+#@end
+//}
+EXPECTED
+    converted = mktmpbookdir('catalog.yml' => "CHAPS:\n - ch01.re\n",
+                             'ch01.re' => ch01_re,
+                             'hello.rb' => hello_rb) do |_dir, _book, _files|
+      preproc.process('ch01.re')
+    end
+    assert_equal expected, converted
+  end
+
+  def test_mapfile_tabwidth_is_4
+    param = { 'tabwidth' => 4 }
+    preproc = ReVIEW::Preprocessor.new(param)
+
+    ch01 = <<-'REFILE'
+//emlist[test1][inc.txt]{
+#@mapfile(inc.txt)
+#@end
+//}
+REFILE
+
+    inc_txt = <<-'INC_TXT'
+test.
+	test2.
+
+	test3.
+
+	  test4.
+
+			test5.
+INC_TXT
+
+    expected = <<-'EXPECTED'
+//emlist[test1][inc.txt]{
+#@mapfile(inc.txt)
+test.
+    test2.
+
+    test3.
+
+      test4.
+
+            test5.
+#@end
+//}
+EXPECTED
+    converted = nil
+    mktmpbookdir('catalog.yml' => "CHAPS:\n - ch01.re\n",
+                 'inc.txt' => inc_txt,
+                 'ch01.re' => ch01) do |_dir, _book, _files|
+      converted = preproc.process('ch01.re')
+    end
+    assert_equal expected, converted
+  end
+
+  def test_maprange
+    preproc = ReVIEW::Preprocessor.new({})
+
+    ch01_re = <<-'REFILE'
+//list[range.rb][range.rb(抜粋)]{
+#@maprange(range.rb,sample)
+#@end
+//}
+REFILE
+
+    range_rb = <<-'RBFILE'
+#!/usr/bin/env ruby
+
+class Hello
+#@range_begin(sample)
+  def hello(name)
+    print "hello, #{name}!\n"
+  end
+#@range_end(sample)
+end
+
+if __FILE__ == $0
+  Hello.new.hello("world")
+end
+RBFILE
+
+    expected = <<-'EXPECTED'
+//list[range.rb][range.rb(抜粋)]{
+#@maprange(range.rb,sample)
+  def hello(name)
+    print "hello, #{name}!\n"
+  end
+#@end
+//}
+EXPECTED
+    converted = mktmpbookdir('catalog.yml' => "CHAPS:\n - ch01.re\n",
+                             'ch01.re' => ch01_re,
+                             'range.rb' => range_rb) do |_dir, _book, _files|
+      preproc.process('ch01.re')
+    end
+    assert_equal expected, converted
+  end
+
+  def test_at_at_maprange
+    preproc = ReVIEW::Preprocessor.new({})
+
+    ch01_re = <<-'REFILE'
+//list[range.c][range.c(抜粋)]{
+#@maprange(range.c,sample)
+#@end
+//}
+REFILE
+
+    range_c = <<-'CFILE'
+#include <stdio.h>
+
+/* #@@range_begin(sample)  */
+void
+put_hello(char *name)
+{
+  printf("hello, %s!\n", name);
+}
+/* #@@range_end(sample) */
+
+int main()
+{
+  put_hello("world");
+}
+CFILE
+
+    expected = <<-'EXPECTED'
+//list[range.c][range.c(抜粋)]{
+#@maprange(range.c,sample)
+void
+put_hello(char *name)
+{
+  printf("hello, %s!\n", name);
+}
+#@end
+//}
+EXPECTED
+    converted = mktmpbookdir('catalog.yml' => "CHAPS:\n - ch01.re\n",
+                             'ch01.re' => ch01_re,
+                             'range.c' => range_c) do |_dir, _book, _files|
+      preproc.process('ch01.re')
+    end
+    assert_equal expected, converted
+  end
 end

data/test/test_reviewheaderlistener.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+require 'rexml/document'
+require 'rexml/streamlistener'
+require 'review/epubmaker'
+
+class ReVIEWHeaderListenerTest < Test::Unit::TestCase
+  def setup
+    @epubmaker = ReVIEW::EPUBMaker.new
+  end
+
+  def teardown
+  end
+
+  def test_epubmaker_parse_headlines
+    # original Re:VIEW source:
+    #
+    # = first chapter
+    # == first section
+    # === first @<embed>{<img src="images/icon1.jpg" alt="subsection" />}
+    # == second section
+    # ==={dummy1} dummy subsection
+    # == third section
+    # ==[notoc] notoc section
+    # ==[notoc]{dummy2} notoc section
+    # ==[nodisp] nodisp section
+    # ==[nodisp]{dummy3} nodisp section
+    # ==[nonum] nonum section
+    # ==[nonum]{dummy4} nonum section
+    Dir.mktmpdir do |_dir|
+      path = File.join(assets_dir, 'header_listener.html')
+      headlines = @epubmaker.parse_headlines(path)
+
+      expected = [{ 'id' => 'h1', 'level' => 1, 'notoc' => nil, 'title' => '第1章　first chapter' },
+                  { 'id' => 'h1-1', 'level' => 2, 'notoc' => nil, 'title' => '1.1　first section' },
+                  { 'id' => 'h1-1-1', 'level' => 3, 'notoc' => nil, 'title' => 'first subsection' },
+                  { 'id' => 'h1-2', 'level' => 2, 'notoc' => nil, 'title' => '1.2　second section' },
+                  { 'id' => 'h1-2-1', 'level' => 3, 'notoc' => nil, 'title' => 'dummy subsection' },
+                  { 'id' => 'h1-3', 'level' => 2, 'notoc' => nil, 'title' => '1.3　third section' },
+                  { 'id' => 'ch01_nonum1', 'level' => 2, 'notoc' => 'true', 'title' => 'notoc section' },
+                  { 'id' => 'dummy2', 'level' => 2, 'notoc' => 'true', 'title' => 'notoc section' },
+                  { 'id' => 'ch01_nonum3', 'level' => 2, 'notoc' => nil, 'title' => 'nodisp section' },
+                  { 'id' => 'dummy3', 'level' => 2, 'notoc' => nil, 'title' => 'nodisp section' },
+                  { 'id' => 'ch01_nonum5', 'level' => 2, 'notoc' => nil, 'title' => 'nonum section' },
+                  { 'id' => 'dummy4', 'level' => 2, 'notoc' => nil, 'title' => 'nonum section' }]
+
+      assert_equal expected, headlines
+    end
+  end
+end

data/test/test_rstbuilder.rb

@@ -513,6 +513,19 @@ EOS
 
    \\sin   1^{2}
 
+EOS
+    assert_equal expected, actual
+  end
+
+  def test_endnote
+    e = assert_raises(ReVIEW::ApplicationError) { compile_block("//endnote[foo][bar]\n\n@<endnote>{foo}\n") }
+    assert_equal ':4: //endnote is found but //printendnotes is not found.', e.message
+
+    actual = compile_block("@<endnote>{foo}\n//endnote[foo][bar]\n//printendnotes\n")
+    expected = <<-'EOS'
+ [(1)]_ 
+
+.. [(1)] bar
 EOS
     assert_equal expected, actual
   end

data/test/test_template.rb

@@ -9,15 +9,25 @@ class TemplateTest < Test::Unit::TestCase
   end
 
   def test_load
-    tmplfile = File.expand_path('./assets/test.xml.erb', File.dirname(__FILE__))
+    tmplfile = File.expand_path('./assets/test.xml.erb', __dir__)
     tmpl = ReVIEW::Template.load(tmplfile)
     assert_equal("<test>\n<name></name>\n</test>\n", tmpl.result(binding))
   end
 
   def test_open_with_value
-    tmplfile = File.expand_path('./assets/test.xml.erb', File.dirname(__FILE__))
+    tmplfile = File.expand_path('./assets/test.xml.erb', __dir__)
     tmpl = ReVIEW::Template.load(tmplfile)
     @name = 'test'
     assert_equal("<test>\n<name>test</name>\n</test>\n", tmpl.result(binding))
   end
+
+  def test_generate
+    result = ReVIEW::Template.generate(path: './assets/test.xml.erb', binding: binding, template_dir: __dir__)
+    assert_equal("<test>\n<name></name>\n</test>\n", result)
+  end
+
+  def test_generate_without_template_dir
+    result = ReVIEW::Template.generate(path: '../test/assets/test.xml.erb', binding: binding)
+    assert_equal("<test>\n<name></name>\n</test>\n", result)
+  end
 end

data/test/test_textmaker_cmd.rb

@@ -29,7 +29,11 @@ class TEXTMakerCmdTest < Test::Unit::TestCase
       ruby_cmd = File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name']) + RbConfig::CONFIG['EXEEXT']
       Dir.chdir(@tmpdir1) do
         _o, e, s = Open3.capture3("#{ruby_cmd} -S #{REVIEW_TEXTMAKER} #{option} #{configfile}")
-        assert_equal '', e
+        if defined?(ReVIEW::TTYLogger)
+          assert_match(/SUCCESS/, e)
+        else
+          assert_equal '', e
+        end
         assert s.success?
       end
       assert File.exist?(File.join(@tmpdir1, targetfile))

data/test/test_tocprinter.rb

@@ -0,0 +1,46 @@
+require 'test_helper'
+require 'review/tocprinter'
+require 'unicode/eaw'
+
+class TOCPrinterTest < Test::Unit::TestCase
+  def setup
+    @toc_printer = ReVIEW::TOCPrinter.new
+  end
+
+  def teardown
+  end
+
+  def test_calc_linesize
+    @toc_printer.calc_char_width = nil
+    size = @toc_printer.calc_linesize('あ いうえおABCD')
+    assert_equal 10, size
+    size = @toc_printer.calc_linesize("あ い\nうえ\nおAB\nCD\n")
+    assert_equal 14, size
+  end
+
+  def test_calc_linesize_with_char_width
+    @toc_printer.calc_char_width = true
+    size = @toc_printer.calc_linesize('あ いうえおABCD')
+    assert_equal 7.5, size
+    size = @toc_printer.calc_linesize("あ い\nうえ\nおAB\nCD\n")
+    assert_equal 9.5, size
+  end
+
+  def test_execute_syntax_book_detail
+    Dir.chdir('./samples/syntax-book') do
+      stdout = $stdout
+      tmp_io = StringIO.new
+      $stdout = tmp_io
+      begin
+        @toc_printer.execute('-d')
+        tmp_io.rewind
+        result = tmp_io.read
+        path = File.join(assets_dir, 'syntax_book_index_detail.txt')
+        expected = File.read(path)
+        assert_equal expected, result
+      ensure
+        $stdout = stdout
+      end
+    end
+  end
+end

data/test/test_topbuilder.rb

@@ -14,6 +14,8 @@ class TOPBuidlerTest < Test::Unit::TestCase
     @config['language'] = 'ja'
     @book = Book::Base.new
     @book.config = @config
+    @log_io = StringIO.new
+    ReVIEW.logger = ReVIEW::Logger.new(@log_io)
     @compiler = ReVIEW::Compiler.new(@builder)
     @chapter = Book::Chapter.new(@book, 1, '-', nil, StringIO.new)
     location = Location.new(nil, nil)
@@ -119,6 +121,11 @@ class TOPBuidlerTest < Test::Unit::TestCase
     assert_equal 'test ★inline test☆◆→等幅フォント太字←◆ test2', actual
   end
 
+  def test_inline_tcy
+    actual = compile_inline('test @<tcy>{A} test2')
+    assert_equal 'test ◆→開始:回転←◆A◆→終了:縦回転←◆ test2', actual
+  end
+
   def test_inline_uchar
     actual = compile_inline('test @<uchar>{2460} test2')
     assert_equal 'test ① test2', actual
@@ -534,10 +541,10 @@ EOS
 
   def test_empty_table
     e = assert_raises(ReVIEW::ApplicationError) { compile_block("//table{\n//}\n") }
-    assert_equal ':2: error: no rows in the table', e.message
+    assert_equal 'no rows in the table', e.message
 
     e = assert_raises(ReVIEW::ApplicationError) { compile_block("//table{\n------------\n//}\n") }
-    assert_equal ':3: error: no rows in the table', e.message
+    assert_equal 'no rows in the table', e.message
   end
 
   def test_inline_table
@@ -874,8 +881,8 @@ EOS
 
 //}
 EOS
-      e = assert_raises(ReVIEW::ApplicationError) { compile_block(src) }
-      assert_match(/minicolumn cannot be nested:/, e.message)
+      assert_raises(ReVIEW::ApplicationError) { compile_block(src) }
+      assert_match(/minicolumn cannot be nested:/, @log_io.string)
     end
   end
 
@@ -891,8 +898,8 @@ EOS
 
 //}
 EOS
-      e = assert_raises(ReVIEW::ApplicationError) { compile_block(src) }
-      assert_match(/minicolumn cannot be nested:/, e.message)
+      assert_raises(ReVIEW::ApplicationError) { compile_block(src) }
+      assert_match(/minicolumn cannot be nested:/, @log_io.string)
     end
   end
 
@@ -907,8 +914,8 @@ EOS
 
 //}
 EOS
-      e = assert_raises(ReVIEW::ApplicationError) { compile_block(src) }
-      assert_match(/minicolumn cannot be nested:/, e.message)
+      assert_raises(ReVIEW::ApplicationError) { compile_block(src) }
+      assert_match(/minicolumn cannot be nested:/, @log_io.string)
     end
   end
 
@@ -985,27 +992,51 @@ EOB
       @book.config['words_file'] = File.join(dir, 'words.csv')
 
       io = StringIO.new
-      @builder.instance_eval{ @logger = ReVIEW::Logger.new(io) }
+      @builder.instance_eval { @logger = ReVIEW::Logger.new(io) }
       actual = compile_block('@<w>{F} @<w>{B} @<wb>{B} @<w>{N}')
       assert_equal %Q(foo bar"\\<>_@<b>{BAZ} ★bar"\\<>_@<b>{BAZ}☆ [missing word: N]\n), actual
       assert_match(/WARN --: :1: word not bound: N/, io.string)
     end
   end
 
+  def test_endnote
+    e = assert_raises(ReVIEW::ApplicationError) { compile_block("//endnote[foo][bar]\n\n@<endnote>{foo}\n") }
+    assert_equal ':4: //endnote is found but //printendnotes is not found.', e.message
+
+    actual = compile_block("@<endnote>{foo}\n//endnote[foo][bar]\n//printendnotes\n")
+    expected = <<-'EOS'
+【後注1】
+◆→開始:後注←◆
+【後注1】bar
+◆→終了:後注←◆
+EOS
+    assert_equal expected, actual
+  end
+
   def test_inline_unknown
-    e = assert_raises(ReVIEW::ApplicationError) { compile_block("@<img>{n}\n") }
-    assert_equal ':1: error: unknown image: n', e.message
-    e = assert_raises(ReVIEW::ApplicationError) { compile_block("@<fn>{n}\n") }
-    assert_equal ':1: error: unknown footnote: n', e.message
-    e = assert_raises(ReVIEW::ApplicationError) { compile_block("@<hd>{n}\n") }
-    assert_equal ':1: error: unknown headline: n', e.message
+    assert_raises(ReVIEW::ApplicationError) { compile_block("@<img>{n}\n") }
+    assert_match(/unknown image: n/, @log_io.string)
+
+    @log_io.string = ''
+    assert_raises(ReVIEW::ApplicationError) { compile_block("@<fn>{n}\n") }
+    assert_match(/unknown footnote: n/, @log_io.string)
+
+    @log_io.string = ''
+    assert_raises(ReVIEW::ApplicationError) { compile_block("@<endnote>{n}\n") }
+    assert_match(/unknown endnote: n/, @log_io.string)
+
+    @log_io.string = ''
+    assert_raises(ReVIEW::ApplicationError) { compile_block("@<hd>{n}\n") }
+    assert_match(/unknown headline: n/, @log_io.string)
     %w[list table column].each do |name|
-      e = assert_raises(ReVIEW::ApplicationError) { compile_block("@<#{name}>{n}\n") }
-      assert_equal ":1: error: unknown #{name}: n", e.message
+      @log_io.string = ''
+      assert_raises(ReVIEW::ApplicationError) { compile_block("@<#{name}>{n}\n") }
+      assert_match(/unknown #{name}: n/, @log_io.string)
     end
     %w[chap chapref title].each do |name|
-      e = assert_raises(ReVIEW::ApplicationError) { compile_block("@<#{name}>{n}\n") }
-      assert_equal ':1: error: key not found: "n"', e.message
+      @log_io.string = ''
+      assert_raises(ReVIEW::ApplicationError) { compile_block("@<#{name}>{n}\n") }
+      assert_match(/key not found: "n"/, @log_io.string)
     end
   end