review 3.1.0 → 5.0.0

data/test/book_test_helper.rb

@@ -13,13 +13,19 @@ module BookTestHelper
     Dir.mktmpdir do |tmpdir|
       Dir.chdir(tmpdir) do
         dir = '.'
-        files.each_pair do |basename, content|
-          path = File.join(dir, basename)
+        files.each_pair do |filename, content|
+          path = File.join(dir, filename)
+          FileUtils.mkdir_p(File.dirname(path))
           File.open(path, 'w') { |o| o.print content }
-          created_files[basename] = path
+          created_files[filename] = path
         end
-        book = Book::Base.load(dir)
-        book.config = ReVIEW::Configure.values
+        conf_path = File.expand_path('config.yml', dir)
+        if File.exist?(conf_path)
+          config = ReVIEW::Configure.create(yamlfile: conf_path)
+        else
+          config = ReVIEW::Configure.values
+        end
+        book = Book::Base.new(dir, config: config)
         yield(dir, book, created_files)
       end
     end

data/test/test_book.rb

@@ -1,8 +1,16 @@
 require 'book_test_helper'
+require 'fileutils'
 
 class BookTest < Test::Unit::TestCase
   include BookTestHelper
 
+  def setup
+    if ENV['GITHUB_WORKSPACE']
+      ENV['TMPDIR'] = File.join(ENV['GITHUB_WORKSPACE'], 'tmp_review')
+      FileUtils.mkdir_p(ENV['TMPDIR'])
+    end
+  end
+
   def assert_same_path(expected, result, *options)
     require 'pathname'
     ex_path = Pathname(expected).realpath
@@ -15,8 +23,8 @@ class BookTest < Test::Unit::TestCase
     test_const = "ReVIEW__BOOK__TEST__#{num}"
     begin
       Dir.mktmpdir do |dir|
-        File.open(File.join(dir, 'review-ext.rb'), 'w') { |o| o.puts "#{test_const} = #{num}" }
-        Book::Base.load(dir)
+        File.write(File.join(dir, 'review-ext.rb'), "#{test_const} = #{num}")
+        Book::Base.new(dir)
         assert_equal num, (Object.class_eval { const_get(test_const) })
       end
     ensure
@@ -32,7 +40,7 @@ class BookTest < Test::Unit::TestCase
   def test_read_chaps
     Dir.mktmpdir do |dir|
       book = Book::Base.new(dir)
-      assert_equal '', book.read_chaps
+      assert_equal [], book.read_chaps
 
       chaps_path = File.join(dir, 'CHAPS')
       re1_path = File.join(dir, "123#{book.ext}")
@@ -42,16 +50,16 @@ class BookTest < Test::Unit::TestCase
       File.open(re1_path, 'w') { |o| o.print "123\n" }
       File.open(re2_path, 'w') { |o| o.print "456\n" }
 
-      assert_equal "abc\n", book.read_chaps
+      assert_equal ['abc'], book.read_chaps
 
       File.unlink(chaps_path)
-      assert_equal "#{re1_path}\n#{re2_path}", book.read_chaps
+      assert_equal [re1_path, re2_path], book.read_chaps
 
       File.unlink(re1_path)
-      assert_equal re2_path, book.read_chaps
+      assert_equal [re2_path], book.read_chaps
 
       File.unlink(re2_path)
-      assert_equal '', book.read_chaps
+      assert_equal [], book.read_chaps
     end
   end
 
@@ -68,17 +76,18 @@ class BookTest < Test::Unit::TestCase
       File.open(chaps_path, 'w') { |o| o.print chaps_content }
 
       assert book.part_exist?
-      assert_equal chaps_content, book.read_part
+      assert_equal %w[abc], book.read_part
 
+      ## do not cache PART data
       File.open(chaps_path, 'w') { |o| o.print "XYZ\n" }
-      assert_equal chaps_content, book.read_part
+      assert_equal %w[XYZ], book.read_part
     end
   end
 
   def test_read_appendix
     Dir.mktmpdir do |dir|
       book = Book::Base.new(dir)
-      assert_equal '', book.read_appendix
+      assert_equal [], book.read_appendix
 
       post_path = File.join(dir, 'POSTDEF')
       re1_path = File.join(dir, "123#{book.ext}")
@@ -88,23 +97,23 @@ class BookTest < Test::Unit::TestCase
       File.open(re1_path, 'w') { |o| o.print "123\n" }
       File.open(re2_path, 'w') { |o| o.print "456\n" }
 
-      assert_equal "abc\n", book.read_appendix
+      assert_equal ['abc'], book.read_appendix
 
       File.unlink(post_path)
-      assert_equal "#{re1_path}\n#{re2_path}", book.read_appendix
+      assert_equal [re1_path, re2_path], book.read_appendix
 
       File.unlink(re1_path)
-      assert_equal re2_path, book.read_appendix
+      assert_equal [re2_path], book.read_appendix
 
       File.unlink(re2_path)
-      assert_equal '', book.read_appendix
+      assert_equal [], book.read_appendix
     end
   end
 
   def test_read_postdef
     Dir.mktmpdir do |dir|
       book = Book::Base.new(dir)
-      assert_equal '', book.read_postdef
+      assert_equal [], book.read_postdef
 
       post_path = File.join(dir, 'POSTDEF')
       re1_path = File.join(dir, "123#{book.ext}")
@@ -114,10 +123,10 @@ class BookTest < Test::Unit::TestCase
       File.open(re1_path, 'w') { |o| o.print "123\n" }
       File.open(re2_path, 'w') { |o| o.print "456\n" }
 
-      assert_equal '', book.read_postdef
+      assert_equal [], book.read_postdef
 
       File.unlink(post_path)
-      assert_equal '', book.read_postdef
+      assert_equal [], book.read_postdef
     end
   end
 
@@ -150,12 +159,12 @@ class BookTest < Test::Unit::TestCase
   end
 
   def test_parse_chapters
-    mktmpbookdir 'CHAPS' => '' do |_dir, book, _files|
+    mktmpbookdir('CHAPS' => '') do |_dir, book, _files|
       parts = book.instance_eval { parse_chapters }
       assert_equal 0, parts.size
     end
 
-    mktmpbookdir 'CHAPS' => "chapter1.re\nchapter2\n" do |dir, book, _files|
+    mktmpbookdir('CHAPS' => "chapter1.re\nchapter2\n") do |dir, book, _files|
       parts = book.instance_eval { parse_chapters }
       assert_equal 1, parts.size
 
@@ -169,7 +178,7 @@ class BookTest < Test::Unit::TestCase
       assert_equal expect, chaps
     end
 
-    mktmpbookdir 'CHAPS' => <<EOC do |dir, book, _files|
+    mktmpbookdir('CHAPS' => <<EOC) do |dir, book, _files|
 part1_chapter1.re
 part1_chapter2.re
 
@@ -237,7 +246,7 @@ EOC
         "part1_chapter1.re\n",
         '',
         [
-          '', # XXX: OK?
+          '' # XXX: OK?
         ]
       ],
       [
@@ -248,15 +257,15 @@ EOC
           ''
         ]
       ]
-    ].each do |n_parts, chaps_text, parts_text, part_names|
+    ].each do |n_parts, chaps, parts, part_names|
       n_test += 1
       Dir.mktmpdir do |dir|
         book = Book::Base.new(dir)
         chaps_path = File.join(dir, 'CHAPS')
-        File.open(chaps_path, 'w') { |o| o.print chaps_text }
-        if parts_text
+        File.open(chaps_path, 'w') { |o| o.print chaps }
+        if parts
           parts_path = File.join(dir, 'PART')
-          File.open(parts_path, 'w') { |o| o.print parts_text }
+          File.open(parts_path, 'w') { |o| o.print parts }
         end
 
         parts = book.instance_eval { parse_chapters }
@@ -271,22 +280,22 @@ EOC
       assert_equal nil, book.prefaces
     end
 
-    mktmpbookdir 'PREDEF' => '' do |_dir, book, _files|
+    mktmpbookdir('PREDEF' => '') do |_dir, book, _files|
       assert_equal nil, book.prefaces # XXX: OK?
     end
 
-    mktmpbookdir 'PREDEF' => 'chapter1',
-                 'chapter1.re' => '' do |_dir, book, files|
-      assert_kind_of Book::Part, book.prefaces
+    mktmpbookdir('PREDEF' => 'chapter1',
+                 'chapter1.re' => '') do |_dir, book, files|
+      assert_kind_of(Book::Part, book.prefaces)
       assert_equal '', book.prefaces.name
       assert_equal 1, book.prefaces.chapters.size
       assert_equal 'chapter1', book.prefaces.chapters.first.name
       assert_equal files['chapter1.re'], book.prefaces.chapters.first.path
     end
 
-    mktmpbookdir 'PREDEF' => "chapter1\n\nchapter2",
-                 'chapter1.re' => '', 'chapter2.re' => '' do |_dir, book, files|
-      assert_kind_of Book::Part, book.prefaces
+    mktmpbookdir('PREDEF' => "chapter1\n\nchapter2",
+                 'chapter1.re' => '', 'chapter2.re' => '') do |_dir, book, files|
+      assert_kind_of(Book::Part, book.prefaces)
       assert_equal '', book.prefaces.name
       assert_equal 2, book.prefaces.chapters.size
       assert_equal 'chapter1', book.prefaces.chapters.first.name
@@ -295,29 +304,29 @@ EOC
       assert_equal files['chapter2.re'], book.prefaces.chapters.last.path
     end
 
-    mktmpbookdir 'PREDEF' => 'chapter1 chapter2',
-                 'chapter1.re' => '', 'chapter2.re' => '' do |_dir, book, _files|
-      assert_kind_of Book::Part, book.prefaces
+    mktmpbookdir('PREDEF' => 'chapter1 chapter2',
+                 'chapter1.re' => '', 'chapter2.re' => '') do |_dir, book, _files|
+      assert_kind_of(Book::Part, book.prefaces)
       assert_equal '', book.prefaces.name
       assert_equal 2, book.prefaces.chapters.size # XXX: OK?
     end
 
-    mktmpbookdir 'PREDEF' => 'not_exist' do |_dir, book, _files|
+    mktmpbookdir('PREDEF' => 'not_exist') do |_dir, book, _files|
       assert_raises FileNotFound do
         assert_equal nil, book.prefaces
       end
     end
 
-    mktmpbookdir 'PREDEF' => 'chapter1.re',
-                 'chapter1.re' => '' do |_dir, book, _files|
-      assert_kind_of Book::Part, book.prefaces
+    mktmpbookdir('PREDEF' => 'chapter1.re',
+                 'chapter1.re' => '') do |_dir, book, _files|
+      assert_kind_of(Book::Part, book.prefaces)
       assert_equal '', book.prefaces.name
       assert_equal 1, book.prefaces.chapters.size
     end
 
-    mktmpbookdir 'PREDEF' => 'chapter1.txt',
-                 'chapter1.txt' => '' do |_dir, book, _files|
-      assert_kind_of Book::Part, book.prefaces
+    mktmpbookdir('PREDEF' => 'chapter1.txt',
+                 'chapter1.txt' => '') do |_dir, book, _files|
+      assert_kind_of(Book::Part, book.prefaces)
       assert_equal '', book.prefaces.name
       assert_equal 1, book.prefaces.chapters.size
     end
@@ -328,13 +337,13 @@ EOC
       assert_equal nil, book.appendix
     end
 
-    mktmpbookdir 'POSTDEF' => '' do |_dir, book, _files|
+    mktmpbookdir('POSTDEF' => '') do |_dir, book, _files|
       assert_equal nil, book.appendix
     end
 
-    mktmpbookdir 'POSTDEF' => 'chapter1',
-                 'chapter1.re' => '' do |_dir, book, files|
-      assert_kind_of Book::Part, book.appendix
+    mktmpbookdir('POSTDEF' => 'chapter1',
+                 'chapter1.re' => '') do |_dir, book, files|
+      assert_kind_of(Book::Part, book.appendix)
       assert_equal '', book.appendix.name
       assert_equal 1, book.appendix.chapters.size
       assert_equal 'chapter1', book.appendix.chapters.first.name
@@ -342,9 +351,9 @@ EOC
       assert_equal 1, book.appendix.chapters.first.number
     end
 
-    mktmpbookdir 'POSTDEF' => "chapter1\n\nchapter2",
-                 'chapter1.re' => '', 'chapter2.re' => '' do |_dir, book, files|
-      assert_kind_of Book::Part, book.appendix
+    mktmpbookdir('POSTDEF' => "chapter1\n\nchapter2",
+                 'chapter1.re' => '', 'chapter2.re' => '') do |_dir, book, files|
+      assert_kind_of(Book::Part, book.appendix)
       assert_equal '', book.appendix.name
       assert_equal 2, book.appendix.chapters.size
       assert_equal 'chapter1', book.appendix.chapters.first.name
@@ -355,32 +364,32 @@ EOC
       assert_equal 2, book.appendix.chapters.last.number
     end
 
-    mktmpbookdir 'POSTDEF' => 'chapter1 chapter2',
-                 'chapter1.re' => '', 'chapter2.re' => '' do |_dir, book, _files|
-      assert_kind_of Book::Part, book.appendix
+    mktmpbookdir('POSTDEF' => 'chapter1 chapter2',
+                 'chapter1.re' => '', 'chapter2.re' => '') do |_dir, book, _files|
+      assert_kind_of(Book::Part, book.appendix)
       assert_equal '', book.appendix.name
       assert_equal 2, book.appendix.chapters.size # XXX: OK?
       assert_equal 1, book.appendix.chapters.first.number
       assert_equal 2, book.appendix.chapters.last.number
     end
 
-    mktmpbookdir 'POSTDEF' => 'not_exist' do |_dir, book, _files|
+    mktmpbookdir('POSTDEF' => 'not_exist') do |_dir, book, _files|
       assert_raises FileNotFound do
         assert_equal nil, book.appendix
       end
     end
 
-    mktmpbookdir 'catalog.yml' => "APPENDIX:\n  - p01.re",
-                 'p01.re' => '= appendix' do |_dir, book, _files|
+    mktmpbookdir('catalog.yml' => "APPENDIX:\n  - p01.re",
+                 'p01.re' => '= appendix') do |_dir, book, _files|
       assert_equal 'appendix', book.appendix.chapters.first.title
       assert_equal 1, book.appendix.chapters.first.number
     end
   end
 
   def test_postscripts
-    mktmpbookdir 'catalog.yml' => "POSTDEF:\n  - b01.re",
-                 'b01.re' => '= back' do |_dir, book, _files|
-      assert_kind_of Book::Part, book.postscripts
+    mktmpbookdir('catalog.yml' => "POSTDEF:\n  - b01.re",
+                 'b01.re' => '= back') do |_dir, book, _files|
+      assert_kind_of(Book::Part, book.postscripts)
       assert_equal 1, book.postscripts.chapters.size
       assert_equal 'back', book.postscripts.chapters.first.title
       assert_equal nil, book.postscripts.chapters.first.number
@@ -398,7 +407,7 @@ EOC
       assert tmp.empty?
     end
 
-    mktmpbookdir 'CHAPS' => "ch1\nch2\n\nch3", 'PART' => "foo\nbar\n" do |_dir, book, _files|
+    mktmpbookdir('CHAPS' => "ch1\nch2\n\nch3", 'PART' => "foo\nbar\n") do |_dir, book, _files|
       parts = book.parts
       assert_equal 2, parts.size
       assert !book.part(0)
@@ -412,8 +421,53 @@ EOC
     end
   end
 
+  def test_parts_in_file
+    mktmpbookdir do |_dir, book, _files|
+      assert book.parts_in_file.empty?
+      assert !book.part(0)
+      assert !book.part(1)
+
+      tmp = []
+      book.each_part { tmp << true }
+      assert tmp.empty?
+    end
+
+    mktmpbookdir('CHAPS' => "ch1.re\nch2.re\n\nch3.re\n",
+                 'PART' => "foo\nbar\n",
+                 'ch1.re' => "= ch1\n\n", 'ch2.re' => "= ch2\n\n",
+                 'ch3.re' => "= ch3\n\n") do |_dir, book, _files|
+      parts = book.parts_in_file
+      assert_equal 0, parts.size
+      assert !book.part(0)
+      assert_equal 'foo', book.part(1).name
+      assert_equal 'bar', book.part(2).name
+      assert !book.part(3)
+
+      tmp = []
+      book.each_part { |p| tmp << p.number }
+      assert_equal [1, 2], tmp
+    end
+
+    mktmpbookdir('CHAPS' => "ch1.re\nch2.re\n\nch3.re\n",
+                 'PART' => "foo.re\nbar.re\n",
+                 'foo.re' => "= part1\n\n", 'bar.re' => "= part2\n\n",
+                 'ch1.re' => "= ch1\n\n", 'ch2.re' => "= ch2\n\n",
+                 'ch3.re' => "= ch3\n\n") do |_dir, book, _files|
+      parts = book.parts_in_file
+      assert_equal 2, parts.size
+      assert !book.part(0)
+      assert_equal 'foo', book.part(1).name
+      assert_equal 'bar', book.part(2).name
+      assert !book.part(3)
+
+      tmp = []
+      book.each_part { |p| tmp << p.number }
+      assert_equal [1, 2], tmp
+    end
+  end
+
   def test_chapters
-    mktmpbookdir 'CHAPS' => "ch1\nch2\n\nch3" do |_dir, book, _files|
+    mktmpbookdir('CHAPS' => "ch1\nch2\n\nch3") do |_dir, book, _files|
       chapters = book.chapters
       assert_equal 3, chapters.size
 
@@ -432,7 +486,7 @@ EOC
       end
     end
 
-    mktmpbookdir 'CHAPS' => "ch1.txt\nch2.txt\n\nch3.txt" do |_dir, book, _files|
+    mktmpbookdir('CHAPS' => "ch1.txt\nch2.txt\n\nch3.txt") do |_dir, book, _files|
       chapters = book.chapters
       assert_equal 3, chapters.size
 
@@ -453,7 +507,7 @@ EOC
   end
 
   def test_next_chapter
-    mktmpbookdir 'CHAPS' => "ch1\nch2" do |_dir, book, _files|
+    mktmpbookdir('CHAPS' => "ch1\nch2") do |_dir, book, _files|
       chapter = book.chapter('ch1')
       assert_equal book.chapter('ch2'), book.next_chapter(chapter)
 
@@ -463,7 +517,7 @@ EOC
   end
 
   def test_prev_chapter
-    mktmpbookdir 'CHAPS' => "ch1\nch2" do |_dir, book, _files|
+    mktmpbookdir('CHAPS' => "ch1\nch2") do |_dir, book, _files|
       chapter = book.chapter('ch2')
       assert_equal book.chapter('ch1'), book.prev_chapter(chapter)
 
@@ -480,14 +534,14 @@ EOC
       assert_equal 0, book.volume.lines
     end
 
-    mktmpbookdir 'CHAPS' => 'chapter1.re', 'chapter1.re' => '12345' do |_dir, book, _files|
+    mktmpbookdir('CHAPS' => 'chapter1.re', 'chapter1.re' => '12345') do |_dir, book, _files|
       assert book.volume
       assert book.volume.bytes > 0
       assert book.volume.chars > 0
       assert book.volume.lines > 0
     end
 
-    mktmpbookdir 'preface.re' => '12345' do |dir, _book, _files|
+    mktmpbookdir('preface.re' => '12345') do |dir, _book, _files|
       Dir.chdir(dir) do
         book2 = Book::Base.new('.')
         assert book2.volume
@@ -506,12 +560,9 @@ EOC
   end
 
   def test_contentdir
-    mktmpbookdir('config.yml' => "contentdir: content\n", 'catalog.yml' => "CHAPS:\n - ch01.re\n") do |dir, _book, _files|
-      Dir.mkdir('content')
-      File.open('content/ch01.re', 'w') { |f| f.puts "foo\n" }
-      book = Book::Base.new(dir)
-      config_file = File.join(dir, 'config.yml')
-      book.load_config(config_file)
+    mktmpbookdir('config.yml' => "contentdir: content\n",
+                 'catalog.yml' => "CHAPS:\n - ch01.re\n",
+                 'content/ch01.re' => "foo\n") do |_dir, book, _files|
       assert_equal "foo\n", book.chapters[0].content
     end
   end
@@ -524,19 +575,13 @@ EOC
   end
 
   def test_page_metric_config
-    mktmpbookdir('config.yml' => "bookname: book\npage_metric: B5\n") do |dir, _book, _files|
-      book = Book::Base.new(dir)
-      config_file = File.join(dir, 'config.yml')
-      book.load_config(config_file)
+    mktmpbookdir('config.yml' => "bookname: book\npage_metric: B5\n") do |_dir, book, _files|
       assert_equal ReVIEW::Book::PageMetric::B5, book.page_metric
     end
   end
 
   def test_page_metric_config_array
-    mktmpbookdir('config.yml' => "bookname: book\npage_metric: [46, 80, 30, 74, 2]\n") do |dir, _book, _files|
-      book = Book::Base.new(dir)
-      config_file = File.join(dir, 'config.yml')
-      book.load_config(config_file)
+    mktmpbookdir('config.yml' => "bookname: book\npage_metric: [50, 40, 36, 40, 1]\n") do |_dir, book, _files|
       assert_equal ReVIEW::Book::PageMetric::B5, book.page_metric
     end
   end