review 4.0.0 → 5.1.1

data/test/test_idgxmlmaker_cmd.rb

@@ -0,0 +1,50 @@
+require 'test_helper'
+require 'tmpdir'
+require 'fileutils'
+require 'yaml'
+require 'rbconfig'
+require 'open3'
+
+REVIEW_IDGXMLMAKER = File.expand_path('../bin/review-idgxmlmaker', __dir__)
+
+class IDGXMLMakerCmdTest < Test::Unit::TestCase
+  def setup
+    @tmpdir1 = Dir.mktmpdir
+
+    @old_rubylib = ENV['RUBYLIB']
+    ENV['RUBYLIB'] = File.expand_path('../lib', __dir__)
+  end
+
+  def teardown
+    FileUtils.rm_rf(@tmpdir1)
+    ENV['RUBYLIB'] = @old_rubylib
+  end
+
+  def common_buildidgxml(bookdir, configfile, targetfile, option)
+    if /mswin|mingw|cygwin/ !~ RUBY_PLATFORM
+      config = prepare_samplebook(@tmpdir1, bookdir, nil, configfile)
+      builddir = File.join(@tmpdir1, config['bookname'] + '-idgxml')
+      assert !File.exist?(builddir)
+
+      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_IDGXMLMAKER} #{option} #{configfile}")
+        if defined?(ReVIEW::TTYLogger)
+          assert_match(/SUCCESS/, e)
+        else
+          assert_equal '', e
+        end
+        assert s.success?
+      end
+      assert File.exist?(File.join(@tmpdir1, targetfile))
+    end
+  end
+
+  def test_idgxmlmaker_cmd_samplebook
+    common_buildidgxml('sample-book/src', 'config.yml', 'book-idgxml/ch01.xml', nil)
+  end
+
+  def test_idgxmlmaker_cmd_syntaxbook
+    common_buildidgxml('syntax-book', 'config.yml', 'syntax-book-idgxml/ch01.xml', nil)
+  end
+end

data/test/test_image_finder.rb

@@ -7,93 +7,75 @@ class ImageFinderTest < Test::Unit::TestCase
   include ReVIEW
 
   def setup
+    if ENV['GITHUB_WORKSPACE']
+      ENV['TMPDIR'] = File.join(ENV['GITHUB_WORKSPACE'], 'tmp_review')
+      FileUtils.mkdir_p(ENV['TMPDIR'])
+    end
+    @dir = Dir.mktmpdir
   end
 
-  def test_find_path_pattern1
-    dir = Dir.mktmpdir
-    begin
-      path = File.join(dir, 'builder/ch01/foo.jpg')
-      FileUtils.mkdir_p(File.dirname(path))
-      FileUtils.touch(path)
-
-      finder = ReVIEW::Book::ImageFinder.new(dir, 'ch01', 'builder', ['.jpg'])
-      assert_equal(path, finder.find_path('foo'))
-    ensure
-      FileUtils.remove_entry_secure(dir)
+  def teardown
+    if @dir
+      FileUtils.remove_entry_secure(@dir)
     end
   end
 
+  def test_find_path_pattern1
+    path = File.join(@dir, 'builder/ch01/foo.jpg')
+    FileUtils.mkdir_p(File.dirname(path))
+    FileUtils.touch(path)
+
+    finder = ReVIEW::Book::ImageFinder.new(@dir, 'ch01', 'builder', ['.jpg'])
+
+    assert_equal(path, finder.find_path('foo'))
+  end
+
   def test_find_path_pattern2
-    dir = Dir.mktmpdir
-    begin
-      path = File.join(dir, 'builder/ch01-foo.jpg')
-      FileUtils.mkdir_p(File.dirname(path))
-      FileUtils.touch(path)
-
-      finder = ReVIEW::Book::ImageFinder.new(dir, 'ch01', 'builder', ['.jpg'])
-      assert_equal(path, finder.find_path('foo'))
-    ensure
-      FileUtils.remove_entry_secure(dir)
-    end
+    path = File.join(@dir, 'builder/ch01-foo.jpg')
+    FileUtils.mkdir_p(File.dirname(path))
+    FileUtils.touch(path)
+
+    finder = ReVIEW::Book::ImageFinder.new(@dir, 'ch01', 'builder', ['.jpg'])
+    assert_equal(path, finder.find_path('foo'))
   end
 
   def test_find_path_pattern3
-    dir = Dir.mktmpdir
-    begin
-      path = File.join(dir, 'builder/foo.jpg')
-      FileUtils.mkdir_p(File.dirname(path))
-      FileUtils.touch(path)
-
-      finder = ReVIEW::Book::ImageFinder.new(dir, 'ch01', 'builder', ['.jpg'])
-      assert_equal(path, finder.find_path('foo'))
-    ensure
-      FileUtils.remove_entry_secure(dir)
-    end
+    path = File.join(@dir, 'builder/foo.jpg')
+    FileUtils.mkdir_p(File.dirname(path))
+    FileUtils.touch(path)
+
+    finder = ReVIEW::Book::ImageFinder.new(@dir, 'ch01', 'builder', ['.jpg'])
+    assert_equal(path, finder.find_path('foo'))
   end
 
   def test_find_path_pattern4
-    dir = Dir.mktmpdir
-    begin
-      path = File.join(dir, 'ch01/foo.jpg')
-      FileUtils.mkdir_p(File.dirname(path))
-      FileUtils.touch(path)
-
-      finder = ReVIEW::Book::ImageFinder.new(dir, 'ch01', 'builder', ['.jpg'])
-      assert_equal(path, finder.find_path('foo'))
-    ensure
-      FileUtils.remove_entry_secure(dir)
-    end
+    path = File.join(@dir, 'ch01/foo.jpg')
+    FileUtils.mkdir_p(File.dirname(path))
+    FileUtils.touch(path)
+
+    finder = ReVIEW::Book::ImageFinder.new(@dir, 'ch01', 'builder', ['.jpg'])
+    assert_equal(path, finder.find_path('foo'))
   end
 
   def test_find_path_pattern5
-    dir = Dir.mktmpdir
-    begin
-      path = File.join(dir, 'ch01-foo.jpg')
-      FileUtils.mkdir_p(File.dirname(path))
-      FileUtils.touch(path)
-
-      finder = ReVIEW::Book::ImageFinder.new(dir, 'ch01', 'builder', ['.jpg'])
-      assert_equal(path, finder.find_path('foo'))
-    ensure
-      FileUtils.remove_entry_secure(dir)
-    end
+    path = File.join(@dir, 'ch01-foo.jpg')
+    FileUtils.mkdir_p(File.dirname(path))
+    FileUtils.touch(path)
+
+    finder = ReVIEW::Book::ImageFinder.new(@dir, 'ch01', 'builder', ['.jpg'])
+    assert_equal(path, finder.find_path('foo'))
   end
 
   def test_find_path_dir_symlink
-    dir = Dir.mktmpdir
-    begin
-      path_src = File.join(dir, 'src')
-      path_dst = File.join(dir, 'ch01')
-      FileUtils.mkdir_p(path_src)
-      FileUtils.symlink(path_src, path_dst)
-      path_srcimg = File.join(path_src, 'foo.jpg')
-      path_dstimg = File.join(path_dst, 'foo.jpg')
-      FileUtils.touch(path_srcimg)
-
-      finder = ReVIEW::Book::ImageFinder.new(dir, 'ch01', 'builder', ['.jpg'])
-      assert_equal(path_dstimg, finder.find_path('foo'))
-    ensure
-      FileUtils.remove_entry_secure(dir)
-    end
+    path_src = File.join(@dir, 'src')
+    path_dst = File.join(@dir, 'ch01')
+    FileUtils.mkdir_p(path_src)
+    FileUtils.symlink(path_src, path_dst)
+    path_srcimg = File.join(path_src, 'foo.jpg')
+    path_dstimg = File.join(path_dst, 'foo.jpg')
+    FileUtils.touch(path_srcimg)
+
+    finder = ReVIEW::Book::ImageFinder.new(@dir, 'ch01', 'builder', ['.jpg'])
+    assert_equal(path_dstimg, finder.find_path('foo'))
   end
 end

data/test/test_img_math.rb

@@ -0,0 +1,111 @@
+require 'test_helper'
+require 'review/htmlbuilder'
+require 'review/img_math'
+require 'mini_magick'
+
+class ImgMathTest < Test::Unit::TestCase
+  def setup
+    @config = ReVIEW::Configure.values
+    @tmpdir = Dir.mktmpdir
+    @config.merge!(
+      'math_format' => 'imgmath',
+      'texcommand' => 'uplatex',
+      'imagedir' => @tmpdir
+    )
+    @config['imgmath_options']['fontsize'] = 24
+    @img_math = ReVIEW::ImgMath.new(@config)
+  end
+
+  def teardown
+    @img_math.cleanup_mathimg
+    FileUtils.rm_rf(@tmpdir)
+  end
+
+  def test_defer_math_image_pathname
+    str1 = '$A > B \\gg C$'
+    key1 = Digest::SHA256.hexdigest(str1)
+    img_path1 = @img_math.defer_math_image(str1, key1)
+
+    assert_equal "_gen_#{key1}.png", File.basename(img_path1)
+  end
+
+  def test_defer_math_image
+    unless support_latex_in_tests?
+      $stderr.puts 'skip test_defer_math_image'
+      return true
+    end
+
+    str1 = '$\\sum_{i=1}^nf_n(x) \\in \\mathbb{R}$'
+    key1 = Digest::SHA256.hexdigest(str1)
+    img_path1 = @img_math.defer_math_image(str1, key1)
+    str2 = '$\\sum_{i=1}^nf_n(X) \\in \\mathbb{R}$'
+    key2 = Digest::SHA256.hexdigest(str2)
+    img_path2 = @img_math.defer_math_image(str2, key2)
+    @img_math.make_math_images
+
+    assert File.exist?(img_path1)
+    assert File.exist?(img_path2)
+
+    val1 = compare_images(img_path1, File.join(assets_dir, 'img_math/img1.png'))
+    assert_equal 0, val1
+
+    val2 = compare_images(img_path2, File.join(assets_dir, 'img_math/img2.png'))
+    assert_equal 0, val2
+
+    val3 = compare_images(img_path1, img_path2)
+    assert val3 > 100
+  end
+
+  def test_make_math_image_pathname
+    unless support_latex_in_tests?
+      $stderr.puts 'skip test_make_math_image_pathname'
+      return true
+    end
+
+    str1 = '$A > B \\gg C$'
+    key1 = Digest::SHA256.hexdigest(str1)
+    img_path1 = @img_math.make_math_image(str1, key1)
+
+    assert_equal "_gen_#{key1}.png", File.basename(img_path1)
+  end
+
+  def test_make_math_image
+    unless support_latex_in_tests?
+      $stderr.puts 'skip test_make_math_image'
+      return true
+    end
+    str1 = '$A > B \\gg C$'
+    key1 = Digest::SHA256.hexdigest(str1)
+    img_path1 = @img_math.make_math_image(str1, key1)
+
+    assert File.exist?(img_path1)
+
+    val1 = compare_images(img_path1, File.join(assets_dir, 'img_math/img3.png'))
+    assert val1 < 10
+  end
+
+  private
+
+  def compare_images(image1, image2)
+    compare = MiniMagick::Tool::Compare.new(whiny: false)
+    compare << '-fuzz'
+    compare << '10%'
+    compare.metric('AE')
+    compare << image1
+    compare << image2
+    compare << File.join(@tmpdir, 'diff.jpg')
+
+    compare.call do |_, dist, _|
+      return dist.to_i
+    end
+  end
+
+  def support_latex_in_tests?
+    begin
+      `uplatex -v`
+      true
+    rescue
+      false
+    end
+  end
+end

data/test/test_index.rb

@@ -1,11 +1,28 @@
 require 'test_helper'
+require 'review/compiler'
 require 'review/book'
 require 'review/book/index'
+require 'review/topbuilder'
+require 'review/i18n'
 
 class IndexTest < Test::Unit::TestCase
   include ReVIEW
+
+  def setup
+    @builder = TOPBuilder.new
+    @config = ReVIEW::Configure.create(config: { 'secnolevel' => 2, 'language' => 'ja' })
+    @book = Book::Base.new(config: @config)
+    @compiler = ReVIEW::Compiler.new(@builder)
+    @chapter = Book::Chapter.new(@book, 1, '-', nil, StringIO.new)
+    location = Location.new(nil, nil)
+    @builder.bind(@compiler, @chapter, location)
+
+    I18n.setup(@config['language'])
+  end
+
   def test_footnote_index
-    fn = Book::FootnoteIndex.parse(['//footnote[foo][bar]'])
+    compile_block("//footnote[foo][bar]\n")
+    fn = @chapter.footnote_index
     items = fn.to_a
     item = items[0]
     assert_equal 'foo', item.id
@@ -13,7 +30,8 @@ class IndexTest < Test::Unit::TestCase
   end
 
   def test_footnote_index_with_escape
-    fn = Book::FootnoteIndex.parse(['//footnote[foo][bar[\]buz]'])
+    compile_block('//footnote[foo][bar[\]buz]' + "\n")
+    fn = @chapter.footnote_index
     items = fn.to_a
     item = items[0]
     assert_equal 'foo', item.id
@@ -21,7 +39,8 @@ class IndexTest < Test::Unit::TestCase
   end
 
   def test_footnote_index_with_escape2
-    fn = Book::FootnoteIndex.parse(['//footnote[foo][bar\\a\\$buz]'])
+    compile_block('//footnote[foo][bar\\a\\$buz]' + "\n")
+    fn = @chapter.footnote_index
     items = fn.to_a
     item = items[0]
     assert_equal 'foo', item.id
@@ -29,7 +48,8 @@ class IndexTest < Test::Unit::TestCase
   end
 
   def test_footnote_index_key?
-    fn = Book::FootnoteIndex.parse(['//footnote[foo][bar]'])
+    compile_block('//footnote[foo][bar]' + "\n")
+    fn = @chapter.footnote_index
     assert_equal true, fn.key?('foo')
 
     ## for compatibility
@@ -38,7 +58,7 @@ class IndexTest < Test::Unit::TestCase
     # rubocop:enable Style/PreferredHashMethods
   end
 
-  def test_headeline_index
+  def test_headline_index
     src = <<-EOB
 = chap1
 == sec1-1
@@ -52,14 +72,13 @@ class IndexTest < Test::Unit::TestCase
 == sec1-3
 ==== sec1-3-0-1
     EOB
-    book = Book::Base.load
-    chap = Book::Chapter.new(book, 1, '-', nil) # dummy
-    index = Book::HeadlineIndex.parse(src, chap)
+    compile_block(src)
+    index = @chapter.headline_index
     assert_equal [2, 2], index['sec1-2|sec1-2-2'].number
     assert_equal '1.2.2', index.number('sec1-2|sec1-2-2')
   end
 
-  def test_headeline_index2
+  def test_headline_index2
     src = <<-EOB
 = chap1
 == sec1-1
@@ -69,14 +88,13 @@ class IndexTest < Test::Unit::TestCase
 == sec1-3
 === sec1-3-1
     EOB
-    book = Book::Base.load
-    chap = Book::Chapter.new(book, 1, '-', nil) # dummy
-    index = Book::HeadlineIndex.parse(src, chap)
+    compile_block(src)
+    index = @chapter.headline_index
     assert_equal [3, 1], index['sec1-3|sec1-3-1'].number
     assert_equal '1.3.1', index.number('sec1-3|sec1-3-1')
   end
 
-  def test_headeline_index3
+  def test_headline_index3
     src = <<-EOB
 = chap1
 == sec1-1
@@ -87,9 +105,8 @@ class IndexTest < Test::Unit::TestCase
 == sec1-3
 === sec1-3-1
     EOB
-    book = Book::Base.load
-    chap = Book::Chapter.new(book, 1, '-', nil) # dummy
-    index = Book::HeadlineIndex.parse(src, chap)
+    compile_block(src)
+    index = @chapter.headline_index
     assert_equal [2, 2], index['sec1-2|sec1-2-2'].number
     assert_equal '1.2.2', index.number('sec1-2|sec1-2-2')
 
@@ -97,7 +114,7 @@ class IndexTest < Test::Unit::TestCase
     assert_equal '1.3.1', index.number('sec1-3|sec1-3-1')
   end
 
-  def test_headeline_index4
+  def test_headline_index4
     src = <<-EOB
 = chap1
 ====[column] c1
@@ -106,14 +123,13 @@ class IndexTest < Test::Unit::TestCase
 === sec1-2-1
 === sec1-2-2
     EOB
-    book = Book::Base.load
-    chap = Book::Chapter.new(book, 1, '-', nil) # dummy
-    index = Book::HeadlineIndex.parse(src, chap)
+    compile_block(src)
+    index = @chapter.headline_index
     assert_equal [2, 2], index['sec1-2|sec1-2-2'].number
     assert_equal '1.2.2', index.number('sec1-2|sec1-2-2')
   end
 
-  def test_headeline_index5
+  def test_headline_index5
     src = <<-EOB
 = chap1
 ====[column] c1
@@ -122,14 +138,13 @@ class IndexTest < Test::Unit::TestCase
 === sec1-2-1
 === sec1-2-2
     EOB
-    book = Book::Base.load
-    chap = Book::Chapter.new(book, 1, '-', nil) # dummy
-    index = Book::HeadlineIndex.parse(src, chap)
+    compile_block(src)
+    index = @chapter.headline_index
     assert_equal [2, 2], index['sec1-2-2'].number
     assert_equal '1.2.2', index.number('sec1-2-2')
   end
 
-  def test_headeline_index6
+  def test_headline_index6
     src = <<-EOB
 = chap1
 == sec1
@@ -137,34 +152,33 @@ class IndexTest < Test::Unit::TestCase
 == sec2
 
     EOB
-    book = Book::Base.load
-    chap = Book::Chapter.new(book, 1, '-', nil) # dummy
-    index = Book::HeadlineIndex.parse(src, chap)
+    compile_block(src)
+    index = @chapter.headline_index
     assert_equal [1, 1], index['target'].number
     assert_equal '1.1.1', index.number('target')
   end
 
-  def test_headeline_index7
+  def test_headline_index7
     src = <<-EOB
 = chap1
 == sec1
 === target
        ^-- dummy target
+
 == sec2
 === target
        ^-- real target but it cannot be detected, because there is another one.
 
     EOB
-    book = Book::Base.load
-    chap = Book::Chapter.new(book, 1, '-', nil) # dummy
-    index = Book::HeadlineIndex.parse(src, chap)
+    compile_block(src)
+    index = @chapter.headline_index
 
     assert_raise ReVIEW::KeyError do
       assert_equal [1, 1], index['target'].number
     end
   end
 
-  def test_headeline_index8
+  def test_headline_index8
     src = <<-EOB
 = chap1
 == sec1
@@ -172,13 +186,13 @@ class IndexTest < Test::Unit::TestCase
 ==== sec1-1-1
 
     EOB
-    book = Book::Base.load
-    chap = Book::Chapter.new(book, 1, '-', nil)
-    index = Book::HeadlineIndex.parse(src, chap)
+    compile_block(src)
+    index = @chapter.headline_index
+
     assert_equal '1.1.1', index.number('sec1-1')
   end
 
-  def test_headeline_index9
+  def test_headline_index9
     src = <<-EOB
 = chap1
 == sec1
@@ -188,13 +202,12 @@ class IndexTest < Test::Unit::TestCase
 ==== sec1-1-1
 === sec1-2
     EOB
-    book = Book::Base.load
-    chap = Book::Chapter.new(book, 1, '-', nil)
-    index = Book::HeadlineIndex.parse(src, chap)
+    compile_block(src)
+    index = @chapter.headline_index
     assert_equal [1, 1, 1], index['sec1-1-1'].number
   end
 
-  def test_headeline_index10
+  def test_headline_index10
     src = <<-EOB
 = chap1
 == sec1
@@ -203,13 +216,12 @@ class IndexTest < Test::Unit::TestCase
 ==== sec1-1-1
 === sec1-2
     EOB
-    book = Book::Base.load
-    chap = Book::Chapter.new(book, 1, '-', nil)
-    index = Book::HeadlineIndex.parse(src, chap)
+    compile_block(src)
+    index = @chapter.headline_index
     assert_equal [1, 1, 1], index['sec1-1-1'].number
   end
 
-  def test_headeline_index11
+  def test_headline_index11
     src = <<-EOB
 = chap1
 ==[nodisp] sec01
@@ -220,9 +232,8 @@ class IndexTest < Test::Unit::TestCase
 ==[nonum] sec03
 == sec04
     EOB
-    book = Book::Base.load
-    chap = Book::Chapter.new(book, 1, '-', nil)
-    index = Book::HeadlineIndex.parse(src, chap)
+    compile_block(src)
+    index = @chapter.headline_index
     assert_equal nil, index['sec01'].number
     assert_equal nil, index['sec02'].number
     assert_equal [1], index['sec1'].number
@@ -232,7 +243,7 @@ class IndexTest < Test::Unit::TestCase
     assert_equal [2], index['sec04'].number
   end
 
-  def test_headeline_index12
+  def test_headline_index12
     src = <<-EOB
 = chap1
 == A
@@ -240,9 +251,8 @@ class IndexTest < Test::Unit::TestCase
 ==[nonum] B
 === B2
     EOB
-    book = Book::Base.load
-    chap = Book::Chapter.new(book, 1, '-', nil)
-    index = Book::HeadlineIndex.parse(src, chap)
+    compile_block(src)
+    index = @chapter.headline_index
     assert_equal [1], index['A'].number
     assert_equal [1, 1], index['A2'].number
     assert_equal nil, index['B'].number