review 3.0.0 → 4.2.0

data/templates/latex/review-jsbook/review-style.sty

@@ -1,5 +1,5 @@
 \NeedsTeXFormat{LaTeX2e}
-\ProvidesPackage{review-style}[2018/07/01]
+\ProvidesPackage{review-style}[2019/09/16]
 
 \RequirePackage{fancyhdr}
 \pagestyle{fancy}
@@ -43,4 +43,7 @@
 \hypersetup{hidelinks}
 
 \floatplacement{figure}{H}
-\floatplacement{table}{htp}
+\floatplacement{table}{H}
+
+% space between English/Japanese characters in list environments (\z@ means 0, no space. You can comment out below line for backward compatibility.)
+\def\reviewlistxkanjiskip{\z@}

data/templates/opf/epubv3.opf.erb

@@ -2,6 +2,7 @@
 <package version="3.0" xmlns="http://www.idpf.org/2007/opf" unique-identifier="BookId" xml:lang="<%= @producer.config['language'] %>"<%= @package_attrs %>>
   <metadata xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:opf="http://www.idpf.org/2007/opf">
 <%= @opf_metainfo %>
+<%= @opf_coverimage %>
   </metadata>
 <%= @opf_manifest %>
 <%= @opf_toc %>

data/templates/web/html/layout-html5.html.erb

@@ -8,8 +8,8 @@
   <link rel="stylesheet" type="text/css" href="<%=h style %>" />
 <%   end %>
 <% end%>
-<% if @next.present? %><link rel="next" title="<%= h(@next_title)%>" href="<%= h(@next.id.to_s+"."+@book.config['htmlext']) %>"><% end %>
-<% if @prev.present? %><link rel="prev" title="<%= h(@prev_title)%>" href="<%= h(@prev.id.to_s+"."+@book.config['htmlext']) %>"><% end %>
+<% if @next.present? %><link rel="next" title="<%= h(@next_title)%>" href="<%= h(@next.id.to_s+"."+@book.config['htmlext']) %>" /><% end %>
+<% if @prev.present? %><link rel="prev" title="<%= h(@prev_title)%>" href="<%= h(@prev.id.to_s+"."+@book.config['htmlext']) %>" /><% end %>
   <meta name="generator" content="Re:VIEW" />
   <title><%=h @title %> | <%=h @book.config.name_of("booktitle")%></title>
 </head>

data/test/assets/test_template.tex

@@ -1,13 +1,14 @@
 \documentclass[dvipdfmx]{review-jsbook}
 \makeatletter
-\def\review@reviewversion{3.0.0.preview3}
+\def\review@reviewversion{3.2.0}
 \def\review@texcompiler{uplatex}
 \def\review@documentclass{review-jsbook}
 
 \def\review@booktitlename{Re:VIEW Sample Book}
 
+\def\review@autnames{anonymous}
 
-\def\review@titlepageauthors{}
+\def\review@titlepageauthors{anonymous　著}
 \def\review@date{2011{-}01{-}01}
 
 \def\review@bookname{sample}
@@ -34,18 +35,37 @@
 \def\review@tablename{表}
 \def\review@appendixname{付録}
 
+\def\review@usecovernombre{true}
 \def\review@titlepage{true}
 
 \def\review@pubhistories{2011年1月1日　発行}
-\def\review@colophonnames{}
+\def\review@colophonnames{著　者 & anonymous \\
+}
 
 \def\reviewprefacefiles{}
 \def\reviewchapterfiles{}
 \def\reviewappendixfiles{}
 \def\reviewpostdeffiles{}
 
+\def\reviewbackcompatibilityhook{
+  \ifdefined\reviewimagecaption\else% for 3.0.0 compatibility
+    \newcommand{\reviewimagecaption}[1]{\caption{##1}}
+  \fi
+  \ifdefined\reviewincludegraphics\else% for 3.2.0 compatibility
+    \DeclareRobustCommand{\reviewincludegraphics}[2][]{%
+      \includegraphics[##1]{##2}}
+  \fi
+  \ifdefined\covermatter\else% for 4.0.0 compatibility
+    \def\covermatter{}
+  \fi
+}
+
 \makeatother
 
+\usepackage{reviewmacro}
+
+%% backward compatibility (defined in config.erb)
+\reviewbackcompatibilityhook
 
 \begin{document}
 
@@ -56,6 +76,7 @@
 
 %% coverpage
 \ifdefined\reviewcoverpagecont
+\covermatter
 \reviewcoverpagecont
 \fi
 

data/test/assets/test_template_backmatter.tex

@@ -1,13 +1,14 @@
 \documentclass[dvipdfmx]{review-jsbook}
 \makeatletter
-\def\review@reviewversion{3.0.0.preview3}
+\def\review@reviewversion{3.2.0}
 \def\review@texcompiler{uplatex}
 \def\review@documentclass{review-jsbook}
 
 \def\review@booktitlename{Re:VIEW Sample Book}
 
+\def\review@autnames{anonymous}
 
-\def\review@titlepageauthors{}
+\def\review@titlepageauthors{anonymous　著}
 \def\review@date{2011{-}01{-}01}
 
 \def\review@bookname{sample}
@@ -34,6 +35,7 @@
 \def\review@tablename{表}
 \def\review@appendixname{付録}
 
+\def\review@usecovernombre{true}
 \def\review@titlepage{true}
 \def\reviewprofilepagecont{\thispagestyle{empty}\chapter*{Profile}
 some profile
@@ -48,15 +50,33 @@ some ad content
 \null}
 
 \def\review@pubhistories{2011年1月1日　発行}
-\def\review@colophonnames{}
+\def\review@colophonnames{著　者 & anonymous \\
+}
 
 \def\reviewprefacefiles{}
 \def\reviewchapterfiles{}
 \def\reviewappendixfiles{}
 \def\reviewpostdeffiles{}
 
+\def\reviewbackcompatibilityhook{
+  \ifdefined\reviewimagecaption\else% for 3.0.0 compatibility
+    \newcommand{\reviewimagecaption}[1]{\caption{##1}}
+  \fi
+  \ifdefined\reviewincludegraphics\else% for 3.2.0 compatibility
+    \DeclareRobustCommand{\reviewincludegraphics}[2][]{%
+      \includegraphics[##1]{##2}}
+  \fi
+  \ifdefined\covermatter\else% for 4.0.0 compatibility
+    \def\covermatter{}
+  \fi
+}
+
 \makeatother
 
+\usepackage{reviewmacro}
+
+%% backward compatibility (defined in config.erb)
+\reviewbackcompatibilityhook
 
 \begin{document}
 
@@ -67,6 +87,7 @@ some ad content
 
 %% coverpage
 \ifdefined\reviewcoverpagecont
+\covermatter
 \reviewcoverpagecont
 \fi
 

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
@@ -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
 
@@ -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 }
@@ -412,6 +421,51 @@ 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|
       chapters = book.chapters
@@ -533,7 +587,7 @@ EOC
   end
 
   def test_page_metric_config_array
-    mktmpbookdir('config.yml' => "bookname: book\npage_metric: [46, 80, 30, 74, 2]\n") do |dir, _book, _files|
+    mktmpbookdir('config.yml' => "bookname: book\npage_metric: [50, 40, 36, 40, 1]\n") do |dir, _book, _files|
       book = Book::Base.new(dir)
       config_file = File.join(dir, 'config.yml')
       book.load_config(config_file)

data/test/test_book_chapter.rb

@@ -37,11 +37,13 @@ class ChapterTest < Test::Unit::TestCase
 
   def test_size
     ch = Book::Chapter.new(nil, nil, nil, __FILE__, :io)
-    assert_equal File.size(__FILE__), ch.size
+    filesize = IO.read(__FILE__, mode: 'rt:BOM|utf-8').size
+    assert_equal filesize, ch.size
 
     File.open(__FILE__, 'r') do |i|
       ch = Book::Chapter.new(nil, nil, nil, nil, i)
-      assert_equal File.size(__FILE__), ch.size
+      filesize = IO.read(__FILE__, mode: 'rt:BOM|utf-8').size
+      assert_equal filesize, ch.size
     end
   end
 

data/test/test_book_part.rb

@@ -46,8 +46,8 @@ class PartTest < Test::Unit::TestCase
 
     part = Book::Part.new(book, nil, chs)
     assert part.volume
-    assert part.volume.bytes > 0
-    assert part.volume.chars > 0
-    assert part.volume.lines > 0
+    assert part.volume.bytes == 0
+    assert part.volume.chars == 0
+    assert part.volume.lines == 0
   end
 end

data/test/test_builder.rb

@@ -80,6 +80,22 @@ class BuidlerTest < Test::Unit::TestCase
     assert_equal [:text, text], @b.compile_inline(text)
   end
 
+  def test_inline_missing_ref
+    b = Builder.new
+    chapter = ReVIEW::Book::Chapter.new(ReVIEW::Book::Base.load, 1, 'chap1', nil, StringIO.new)
+    b.bind(nil, chapter, nil)
+    e = assert_raises(ReVIEW::ApplicationError) { b.inline_list('unknown|list1') }
+    assert_equal ': error: unknown list: unknown|list1', e.message
+    e = assert_raises(ReVIEW::ApplicationError) { b.inline_table('unknown|table1') }
+    assert_equal ': error: unknown table: unknown|table1', e.message
+    e = assert_raises(ReVIEW::ApplicationError) { b.inline_img('unknown|img1') }
+    assert_equal ': error: unknown image: unknown|img1', e.message
+    e = assert_raises(ReVIEW::ApplicationError) { b.inline_column('unknown|column1') }
+    assert_equal ': error: unknown column: unknown|column1', e.message
+    e = assert_raises(ReVIEW::ApplicationError) { b.inline_fn('unknown|footnote1') }
+    assert_equal ': error: unknown footnote: unknown|footnote1', e.message
+  end
+
   class XBuilder < Builder
     def list_header(id, caption)
     end

data/test/test_catalog.rb

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'book_test_helper'
 require 'review/catalog'
 
 class CatalogTest < Test::Unit::TestCase
@@ -7,61 +8,48 @@ class CatalogTest < Test::Unit::TestCase
 
   def test_predef
     sut = Catalog.new(yaml)
-    exp = <<-EOS
-pre01.re
-pre02.re
-    EOS
-    assert_equal(exp.chomp, sut.predef)
+    exp = %w[pre01.re pre02.re]
+    assert_equal(exp, sut.predef)
   end
 
   def test_chaps
     sut = Catalog.new(yaml)
-    exp = <<-EOS
-ch01.re
-ch02.re
-    EOS
-    assert_equal(exp.chomp, sut.chaps)
+    exp = %w[ch01.re ch02.re]
+    assert_equal(exp, sut.chaps)
   end
 
   def test_chaps_empty
     yaml = StringIO.new
     sut = Catalog.new(yaml)
-    assert_equal('', sut.chaps)
+    assert_equal([], sut.chaps)
   end
 
   def test_appendix
     sut = Catalog.new(yaml)
-    exp = <<-EOS
-post01.re
-post02.re
-    EOS
-    assert_equal(exp.chomp, sut.appendix)
+    exp = %w[post01.re post02.re]
+    assert_equal(exp, sut.appendix)
   end
 
   def test_chaps_with_parts
     sut = Catalog.new(yaml_with_parts)
-    exp = <<-EOS
-ch01.re
-ch02.re
-ch03.re
-ch04.re
-ch05.re
-    EOS
-    assert_equal(exp.chomp, sut.chaps)
+    exp = %w[ch01.re ch02.re ch03.re ch04.re ch05.re]
+    assert_equal(exp, sut.chaps)
   end
 
   def test_parts
     sut = Catalog.new(yaml_with_parts)
-    exp = <<-EOS
-part1.re
-part2.re
-    EOS
-    assert_equal(exp.chomp, sut.parts)
+    exp = %w[part1.re part2.re]
+    assert_equal(exp, sut.parts)
   end
 
   def test_parts_with_empty
     sut = Catalog.new(yaml)
-    assert_equal('', sut.parts)
+    assert_equal([], sut.parts)
+  end
+
+  def test_empty_parts
+    sut = Catalog.new(StringIO.new)
+    assert_equal([], sut.parts_with_chaps)
   end
 
   def test_parts2
@@ -75,20 +63,14 @@ part2.re
 
   def test_postdef
     sut = Catalog.new(yaml)
-    exp = <<-EOS
-back01.re
-back02.re
-    EOS
-    assert_equal(exp.chomp, sut.postdef)
+    exp = %w[back01.re back02.re]
+    assert_equal(exp, sut.postdef)
   end
 
   def test_from_object
     sut = Catalog.new(yaml_hash)
-    exp = <<-EOS
-ch01.re
-ch02.re
-    EOS
-    assert_equal(exp.chomp, sut.chaps)
+    exp = %w[ch01.re ch02.re]
+    assert_equal(exp, sut.chaps)
   end
 
   def test_validate
@@ -149,7 +131,7 @@ ch02.re
   private
 
   def yaml
-    StringIO.new <<-EOS
+    StringIO.new(<<-EOS)
 
 PREDEF:
   - pre01.re
@@ -177,7 +159,7 @@ POSTDEF:
   end
 
   def yaml_with_parts
-    StringIO.new <<-EOS
+    StringIO.new(<<-EOS)
 CHAPS:
   - ch01.re
   - part1.re: