review 3.2.0 → 4.0.0

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

@@ -132,23 +132,23 @@
 \newenvironment{reviewlistblock}{\needspace{2\Cvs}}{}
 
 \newenvironment{reviewemlist}{%
-  \medskip\small\begin{shaded}\setlength{\baselineskip}{1.3zw}\begin{alltt}}{%
+  \medskip\small\begin{shaded}\ifdefined\reviewlistxkanjiskip\xkanjiskip=\reviewlistxkanjiskip\fi\setlength{\baselineskip}{1.3zw}\begin{alltt}}{%
   \end{alltt}\end{shaded}}
 
 \newenvironment{reviewlist}{%
-  \begin{shaded}\small\setlength{\baselineskip}{1.3zw}\begin{alltt}}{%
+  \begin{shaded}\small\ifdefined\reviewlistxkanjiskip\xkanjiskip=\reviewlistxkanjiskip\fi\setlength{\baselineskip}{1.3zw}\begin{alltt}}{%
   \end{alltt}\end{shaded}\par\vspace*{0.5zw}}
 
 \newenvironment{reviewsource}{%
-  \begin{shaded}\small\setlength{\baselineskip}{1.3zw}\begin{alltt}}{%
+  \begin{shaded}\small\ifdefined\reviewlistxkanjiskip\xkanjiskip=\reviewlistxkanjiskip\fi\setlength{\baselineskip}{1.3zw}\begin{alltt}}{%
   \end{alltt}\end{shaded}\par\vspace*{0.5zw}}
 
 \newenvironment{reviewcmd}{%
-  \color{white}\medskip\small\begin{shadedb}\setlength{\baselineskip}{1.3zw}\begin{alltt}}{%
+  \color{white}\medskip\small\ifdefined\reviewlistxkanjiskip\xkanjiskip=\reviewlistxkanjiskip\fi\begin{shadedb}\setlength{\baselineskip}{1.3zw}\begin{alltt}}{%
   \end{alltt}\end{shadedb}}
 
 \newenvironment{reviewbox}{%
-  \medskip\small\begin{framed}\setlength{\baselineskip}{1.3zw}\begin{alltt}}{%
+  \medskip\small\begin{framed}\ifdefined\reviewlistxkanjiskip\xkanjiskip=\reviewlistxkanjiskip\fi\setlength{\baselineskip}{1.3zw}\begin{alltt}}{%
   \end{alltt}\end{framed}}
 
 \newenvironment{reviewtable}[1]{%
@@ -205,7 +205,7 @@
 \newcommand{\reviewlistref}[1]{\review@intn@list #1}
 \newcommand{\reviewequationref}[1]{\review@intn@equation #1}
 \newcommand{\reviewbibref}[2]{#1}
-\newcommand{\reviewcolumnref}[2]{\review@intn@columnname #1}
+\newcommand{\reviewcolumnref}[2]{#1}
 \newcommand{\reviewsecref}[2]{#1}
 
 \newenvironment{reviewpart}{%
@@ -264,10 +264,58 @@
 \DeclareRobustCommand{\reviewunderline}[1]{\Underline{#1}}
 \DeclareRobustCommand{\reviewit}[1]{\textit{#1}}
 \DeclareRobustCommand{\reviewbold}[1]{\textbf{#1}}
-\DeclareRobustCommand{\reviewcode}[1]{\texttt{#1}}
-\DeclareRobustCommand{\reviewtt}[1]{\texttt{#1}}
-\DeclareRobustCommand{\reviewtti}[1]{\texttt{\textit{#1}}}
-\DeclareRobustCommand{\reviewttb}[1]{\texttt{\textbf{#1}}}
+
+% allow break line in tt
+% contributed by @zr_tex8r
+\newif\ifreview@ba@break
+\def\review@ba@end{\review@ba@end@}
+\DeclareRobustCommand{\reviewbreakall}[1]{%
+  \begingroup
+    \review@ba@breakfalse
+    \review@break@all@a#1\review@ba@end
+  \endgroup
+}
+\def\review@break@all@a{%
+  \futurelet\review@ba@tok\review@break@all@b
+}
+\def\review@break@all@b{%
+  \ifx\review@ba@tok\review@ba@end
+    \let\next\@gobble
+  \else\ifx\review@ba@tok\@sptoken
+    \let\next\review@break@all@c
+  \else\ifx\review@ba@tok~%
+    \let\next\review@break@all@d
+  \else\ifx\review@ba@tok\bgroup
+    \let\next\review@break@all@e
+  \else
+    \let\next\review@break@all@f
+  \fi\fi\fi\fi
+  \next
+}
+\expandafter\def\expandafter\review@break@all@c\space{%
+  \space
+  \review@ba@breakfalse
+  \review@break@all@a
+}
+\def\review@break@all@d#1{%
+  \review@break@all@f{\mbox{\space}}%
+}
+\def\review@break@all@e#1{%
+  \review@break@all@f{{#1}}%
+}
+\def\review@break@all@f#1{%
+  \ifreview@ba@break
+    \hskip0pt plus 0.02em\relax
+  \fi
+  #1%
+  \review@ba@breaktrue
+  \review@break@all@a
+}
+\DeclareRobustCommand{\reviewtt}[1]{{\ttfamily\reviewbreakall{#1}}}
+\DeclareRobustCommand{\reviewcode}[1]{{\ttfamily\reviewbreakall{#1}}}
+\DeclareRobustCommand{\reviewtti}[1]{{\ttfamily\itshape\reviewbreakall{#1}}}
+\DeclareRobustCommand{\reviewttb}[1]{{\ttfamily\bfseries\reviewbreakall{#1}}}
+
 \DeclareRobustCommand{\reviewbou}[1]{\kenten{#1}}
 
 %% @<del> is ignored in LaTeX with default style
@@ -350,6 +398,13 @@
 }
 
 % cover
+\newcommand*\covermatter{%
+  \ifdefined\review@usecovernombre%
+    \pagenumbering{coverpagezero}
+    \setcounter{page}{0}% force to even page, to avoid empty page
+  \fi
+}
+
 \if@reclscover
   \ifdefined\review@coverimage
     \def\reviewcoverpagecont{%

data/templates/latex/review-jsbook/review-jsbook.cls

@@ -486,5 +486,9 @@
       %% \setcounter{page}\@ne
     \fi}
 
+%% 表紙のノンブル
+\def\coverpagezero#1{\expandafter\@coverpagezero\csname c@#1\endcsname}
+\def\@coverpagezero#1{cover}
+
 \listfiles
 \endinput

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

@@ -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/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,10 +35,12 @@
 \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{}
@@ -52,10 +55,14 @@
     \DeclareRobustCommand{\reviewincludegraphics}[2][]{%
       \includegraphics[##1]{##2}}
   }
+  \@ifundefined{covermatter}{% for 4.0.0 compatibility
+    \def\covermatter{}
+  }
 }
 
 \makeatother
 
+\usepackage{reviewmacro}
 
 %% backward compatibility (defined in config.erb)
 \reviewbackcompatibilityhook
@@ -69,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,7 +50,8 @@ some ad content
 \null}
 
 \def\review@pubhistories{2011年1月1日　発行}
-\def\review@colophonnames{}
+\def\review@colophonnames{著　者 & anonymous \\
+}
 
 \def\reviewprefacefiles{}
 \def\reviewchapterfiles{}
@@ -63,10 +66,14 @@ some ad content
     \DeclareRobustCommand{\reviewincludegraphics}[2][]{%
       \includegraphics[##1]{##2}}
   }
+  \@ifundefined{covermatter}{% for 4.0.0 compatibility
+    \def\covermatter{}
+  }
 }
 
 \makeatother
 
+\usepackage{reviewmacro}
 
 %% backward compatibility (defined in config.erb)
 \reviewbackcompatibilityhook
@@ -80,6 +87,7 @@ some ad content
 
 %% coverpage
 \ifdefined\reviewcoverpagecont
+\covermatter
 \reviewcoverpagecont
 \fi
 

data/test/test_book.rb

@@ -32,7 +32,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 +42,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 +68,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 +89,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 +115,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
 
@@ -248,15 +249,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 +413,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

data/test/test_catalog.rb

@@ -7,61 +7,43 @@ 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
@@ -80,20 +62,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
@@ -154,7 +130,7 @@ ch02.re
   private
 
   def yaml
-    StringIO.new <<-EOS
+    StringIO.new(<<-EOS)
 
 PREDEF:
   - pre01.re
@@ -182,7 +158,7 @@ POSTDEF:
   end
 
   def yaml_with_parts
-    StringIO.new <<-EOS
+    StringIO.new(<<-EOS)
 CHAPS:
   - ch01.re
   - part1.re: