review 4.1.0 → 4.2.0

data/lib/review/topbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2019 Minero Aoki, Kenshi Muto
+# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto
 #               2002-2006 Minero Aoki
 #
 # This program is free software.
@@ -95,12 +95,18 @@ module ReVIEW
       blank
       puts "◆→開始:#{@titles['list']}←◆"
       begin
-        list_header(id, caption, lang)
+        if caption_top?('list')
+          list_header(id, caption, lang)
+          blank
+        end
+        list_body(id, lines, lang)
+        unless caption_top?('list')
+          blank
+          list_header(id, caption, lang)
+        end
       rescue KeyError
         error "no such list: #{id}"
       end
-      blank
-      list_body(id, lines, lang)
       puts "◆→終了:#{@titles['list']}←◆"
       blank
     end
@@ -122,8 +128,13 @@ module ReVIEW
     def base_block(type, lines, caption = nil)
       blank
       puts "◆→開始:#{@titles[type]}←◆"
-      puts "■#{compile_inline(caption)}" if caption.present?
+      if caption_top?('list') && caption.present?
+        puts "■#{compile_inline(caption)}"
+      end
       puts lines.join("\n")
+      if !caption_top?('list') && caption.present?
+        puts "■#{compile_inline(caption)}"
+      end
       puts "◆→終了:#{@titles[type]}←◆"
       blank
     end
@@ -140,10 +151,15 @@ module ReVIEW
     def emlistnum(lines, caption = nil, _lang = nil)
       blank
       puts "◆→開始:#{@titles['emlist']}←◆"
-      puts "■#{compile_inline(caption)}" if caption.present?
+      if caption_top?('list') && caption.present?
+        puts "■#{compile_inline(caption)}"
+      end
       lines.each_with_index do |line, i|
         puts((i + 1).to_s.rjust(2) + ": #{line}")
       end
+      if !caption_top?('list') && caption.present?
+        puts "■#{compile_inline(caption)}"
+      end
       puts "◆→終了:#{@titles['emlist']}←◆"
       blank
     end
@@ -152,12 +168,18 @@ module ReVIEW
       blank
       puts "◆→開始:#{@titles['list']}←◆"
       begin
-        list_header(id, caption, lang)
+        if caption_top?('list') && caption.present?
+          list_header(id, caption, lang)
+          blank
+        end
+        listnum_body(lines, lang)
+        if !caption_top?('list') && caption.present?
+          blank
+          list_header(id, caption, lang)
+        end
       rescue KeyError
         error "no such list: #{id}"
       end
-      blank
-      listnum_body(lines, lang)
       puts "◆→終了:#{@titles['list']}←◆"
       blank
     end
@@ -173,8 +195,10 @@ module ReVIEW
       metrics = " #{metrics}" if metrics.present?
       blank
       puts "◆→開始:#{@titles['image']}←◆"
-      image_header(id, caption)
-      blank
+      if caption_top?('image')
+        image_header(id, caption)
+        blank
+      end
       if @chapter.image_bound?(id)
         puts "◆→#{@chapter.image(id).path}#{metrics}←◆"
       else
@@ -183,6 +207,10 @@ module ReVIEW
           puts line
         end
       end
+      unless caption_top?('image')
+        blank
+        image_header(id, caption)
+      end
       puts "◆→終了:#{@titles['image']}←◆"
       blank
     end
@@ -198,7 +226,7 @@ module ReVIEW
     def texequation(lines, id = nil, caption = '')
       blank
       puts "◆→開始:#{@titles['texequation']}←◆"
-      texequation_header(id, caption)
+      texequation_header(id, caption) if caption_top?('equation')
 
       if @book.config['imgmath']
         fontsize = @book.config['imgmath_options']['fontsize'].to_f
@@ -214,6 +242,7 @@ module ReVIEW
         puts lines.join("\n")
       end
 
+      texequation_header(id, caption) unless caption_top?('equation')
       puts "◆→終了:#{@titles['texequation']}←◆"
       blank
     end
@@ -419,13 +448,18 @@ module ReVIEW
       metrics = parse_metric('top', metric)
       metrics = " #{metrics}" if metrics.present?
       blank
+      if caption_top?('image') && caption.present?
+        puts "図　#{compile_inline(caption)}"
+      end
       begin
         puts "◆→画像 #{@chapter.image(id).path.sub(%r{\A\./}, '')}#{metrics}←◆"
       rescue
         warn "image not bound: #{id}"
         puts "◆→画像 #{id}←◆"
       end
-      puts "図　#{compile_inline(caption)}" if caption.present?
+      if !caption_top?('image') && caption.present?
+        puts "図　#{compile_inline(caption)}"
+      end
       blank
     end
 

data/lib/review/version.rb

@@ -1,3 +1,3 @@
 module ReVIEW
-  VERSION = '4.1.0'.freeze
+  VERSION = '4.2.0'.freeze
 end

data/lib/review/volumeprinter.rb

@@ -0,0 +1,99 @@
+#
+# Copyright (c) 2014-2020 Minero Aoki, Kenshi Muto
+#               2003-2014 Minero Aoki
+#
+# This program is free software.
+# You can distribute or modify this program under the terms of
+# the GNU LGPL, Lesser General Public License version 2.1.
+# For details of the GNU LGPL, see the file "COPYING".
+#
+require 'optparse'
+require 'review'
+require 'review/i18n'
+require 'review/plaintextbuilder'
+
+include ReVIEW::TextUtils
+
+module ReVIEW
+  class VolumePrinter
+    def self.execute(*args)
+      new.execute(*args)
+    end
+
+    def initialize
+      @logger = ReVIEW.logger
+      @config = ReVIEW::Configure.values
+      @yamlfile = 'config.yml'
+    end
+
+    def execute(*args)
+      parse_options(args)
+      @book = ReVIEW::Book::Base.load
+      @book.config = @config
+      unless File.readable?(@yamlfile)
+        @logger.error("No such fiile or can't open #{@yamlfile}.")
+        exit 1
+      end
+      @book.load_config(@yamlfile)
+      I18n.setup(@book.config['language'])
+
+      begin
+        @book.each_part do |part|
+          if part.number
+            print_chapter_volume(part)
+          end
+          part.each_chapter do |chap|
+            print_chapter_volume(chap)
+          end
+        end
+      rescue ReVIEW::FileNotFound => e
+        @logger.error e
+        exit 1
+      end
+      puts '============================='
+      print_volume(@book.volume)
+    end
+
+    def parse_options(args)
+      opts = OptionParser.new
+      opts.version = ReVIEW::VERSION
+      opts.on('--yaml=YAML', 'Read configurations from YAML file.') { |yaml| @yamlfile = yaml }
+      opts.on('--help', 'Print this message and quit') do
+        puts opts.help
+        exit 0
+      end
+      begin
+        opts.parse!(args)
+      rescue OptionParser::ParseError => e
+        @logger.error e.message
+        $stderr.puts opts.help
+        exit 1
+      end
+    end
+
+    def print_chapter_volume(chap)
+      builder = ReVIEW::PLAINTEXTBuilder.new
+      builder.bind(ReVIEW::Compiler.new(builder), chap, nil)
+
+      vol = chap.volume
+      title = chap.format_number
+      unless title.empty?
+        title += '  '
+      end
+      begin
+        title += builder.compile_inline(chap.title)
+      rescue ReVIEW::ApplicationError => e
+        @logger.warn "#{chap.name} : #{e.message.sub(/.+error: /, '')}"
+      end
+
+      printf("%3dKB %6dC %5dL %3dP  %s %-s\n",
+             vol.kbytes, vol.chars, vol.lines, vol.page,
+             "#{chap.name} ".ljust(15, '.'), title)
+    end
+
+    def print_volume(vol)
+      # total
+      printf("%3dKB %6dC %5dL %3dP\n", vol.kbytes, vol.chars, vol.lines, vol.page)
+    end
+  end
+end

data/lib/review/webmaker.rb

@@ -118,7 +118,7 @@ module ReVIEW
       copy_backmatter(@path)
 
       math_dir = "./#{@config['imagedir']}/_review_math"
-      if @config['imgmath'] && File.exist?("#{math_dir}/__IMGMATH_BODY__.tex")
+      if @config['imgmath'] && File.exist?("#{math_dir}/__IMGMATH_BODY__.map")
         make_math_images(math_dir)
       end
 

data/lib/review/webtocprinter.rb

@@ -6,49 +6,52 @@ module ReVIEW
     include HTMLUtils
 
     def self.book_to_string(book)
-      io = StringIO.new
-      ReVIEW::WEBTOCPrinter.new(1, {}, io).print_book(book)
-      io.seek(0)
-      io.read
+      ReVIEW::WEBTOCPrinter.new.print_book(book)
     end
 
     def print_book(book)
-      @out.puts '<ul class="book-toc">'
-      @out.puts %Q(<li><a href="index.html">TOP</a></li>\n)
-      book.each_part do |part|
-        print_part(part)
-      end
-      @out.puts '</ul>'
+      @book = book
+      @indent = nil
+      @upper = 1 # only part and chapter
+      print_result(build_result_array)
     end
 
-    def print_part(part)
-      if part.number
-        if part.file?
-          ext = part.book.config['htmlext'] || 'html'
-          path = File.basename(part.path.sub(/\.re/, '.' + ext))
-          @out.puts %Q(<li><a href="#{path}">#{h(I18n.t('part_short', part.number) + ' ' + part.title)}</a>\n<ul>\n)
+    def print_result(result_array)
+      content = <<EOT
+<ul class="book-toc">
+<li><a href="index.html">TOP</a></li>
+EOT
+
+      path = ''
+      result_array.each do |result|
+        unless result[:headline]
+          result[:headline] = '-'
+        end
+
+        if result[:name]
+          path = "#{result[:name]}.#{@book.config['htmlext']}"
+          next
+        end
+
+        if result[:part]
+          if result[:part] == 'end'
+            content << "</ul></li>\n"
+          end
+          next
+        end
+
+        if path.start_with?('.')
+          content << "<li>#{escape(result[:headline])}"
         else
-          @out.puts %Q(<li>#{h(I18n.t('part_short', part.number) + ' ' + part.title)}\n<ul>\n)
+          content << %Q(<li><a href="#{path}">#{escape(result[:headline])}</a>)
+        end
+        if result[:level] == 0
+          content << "\n<ul>" # part
+        else
+          content << "</li>\n"
         end
       end
-      part.each_chapter do |chap|
-        print_chapter(chap)
-      end
-      if part.number
-        @out.puts "</ul>\n</li>\n"
-      end
-    end
-
-    def print_chapter(chap)
-      chap_node = TOCParser.chapter_node(chap)
-      ext = chap.book.config['htmlext'] || 'html'
-      path = File.basename(chap.path.sub(/\.re/, '.' + ext))
-      label = if chap_node.number && chap.on_chaps?
-                "#{I18n.t('chapter_short', chap.number)} #{chap.title}"
-              else
-                chap.title
-              end
-      @out.puts %Q(<li><a href="#{path}">#{h(label)}</a></li>\n)
+      content << "</ul>\n"
     end
   end
 end

data/review.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |gem|
   gem.summary     = 'Re:VIEW: a easy-to-use digital publishing system'
   gem.description = 'Re:VIEW is a digital publishing system for books and ebooks. It supports InDesign, EPUB and LaTeX.'
   gem.required_rubygems_version = Gem::Requirement.new('>= 0') if gem.respond_to?(:required_rubygems_version=)
-  gem.date = '2020-02-29'
+  gem.date = '2020-06-29'
 
   gem.files         = `git ls-files`.split("\n")
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/samples/sample-book/src/config.yml

@@ -35,7 +35,7 @@ colophon: true
 # font_ext: ["ttf", "woff", "otf"]
 # catalogfile: catalog.yml
 # page_metric: A5
-# page_metric: [40,80,40,80,2]
+# page_metric: [40,34,29,34]
 # direction: "ltr"
 
 epubmaker:

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/test_book.rb

@@ -587,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_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_helper.rb

@@ -14,7 +14,10 @@ end
 
 def prepare_samplebook(srcdir, bookdir, latextemplatedir, configfile)
   samplebook_dir = File.expand_path("../samples/#{bookdir}/", File.dirname(__FILE__))
-  FileUtils.cp_r(Dir.glob(File.join(samplebook_dir, '*')), srcdir)
+  files = Dir.glob(File.join(samplebook_dir, '*'))
+  # ignore temporary built files
+  files.delete_if { |file| file =~ /.*\-(pdf|epub|text)/ || file == 'webroot' }
+  FileUtils.cp_r(files, srcdir)
   if latextemplatedir
     # copy from review-jsbook or review-jlreq
     template_dir = File.expand_path("../templates/latex/#{latextemplatedir}/", File.dirname(__FILE__))

data/test/test_htmlbuilder.rb

@@ -546,6 +546,18 @@ EOS
 図1.1: sample photo
 </p>
 </div>
+EOS
+    assert_equal expected, actual
+
+    @config['caption_position']['image'] = 'top'
+    actual = compile_block("//image[sampleimg][sample photo]{\n//}\n")
+    expected = <<-EOS
+<div id="sampleimg" class="image">
+<p class="caption">
+図1.1: sample photo
+</p>
+<img src="images/chap1-sampleimg.png" alt="sample photo" />
+</div>
 EOS
     assert_equal expected, actual
   end
@@ -622,6 +634,18 @@ EOS
 図: sample photo
 </p>
 </div>
+EOS
+    assert_equal expected, actual
+
+    @config['caption_position']['image'] = 'top'
+    actual = compile_block("//indepimage[sampleimg][sample photo]\n")
+    expected = <<-EOS
+<div id="sampleimg" class="image">
+<p class="caption">
+図: sample photo
+</p>
+<img src="images/chap1-sampleimg.png" alt="sample photo" />
+</div>
 EOS
     assert_equal expected, actual
   end
@@ -806,6 +830,20 @@ test1.5
 test<i>2</i>
 </pre>
 </div>
+EOS
+    assert_equal expected, actual
+
+    @config['caption_position']['list'] = 'bottom'
+    actual = compile_block("//list[samplelist][this is @<b>{test}<&>_]{\ntest1\ntest1.5\n\ntest@<i>{2}\n//}\n")
+    expected = <<-EOS
+<div id="samplelist" class="caption-code">
+<pre class="list">test1
+test1.5
+
+test<i>2</i>
+</pre>
+<p class="caption">リスト1.1: this is <b>test</b>&lt;&amp;&gt;_</p>
+</div>
 EOS
     assert_equal expected, actual
   end
@@ -1023,6 +1061,29 @@ EOS
  4: end
 </pre>
 </div>
+EOS
+
+    assert_equal expected, actual
+
+    @config['caption_position']['list'] = 'bottom'
+    actual = compile_block(<<-EOS)
+//listnum[samplelist][this is @<b>{test}<&>_][ruby]{
+def foo(a1, a2=:test)
+  (1..3).times{|i| a.include?(:foo)}
+  return true
+end
+//}
+EOS
+
+    expected = <<-EOS
+<div id="samplelist" class="code">
+<pre class="list language-ruby"> 1: def foo(a1, a2=:test)
+ 2:   (1..3).times{|i| a.include?(:foo)}
+ 3:   return true
+ 4: end
+</pre>
+<p class="caption">リスト1.1: this is <b>test</b>&lt;&amp;&gt;_</p>
+</div>
 EOS
 
     assert_equal expected, actual
@@ -1220,6 +1281,20 @@ bar
 buz
 </pre>
 </div>
+EOS
+    assert_equal expected, actual
+
+    @config['caption_position']['list'] = 'bottom'
+    actual = compile_block("//source[foo/bar/test.rb]{\nfoo\nbar\n\nbuz\n//}\n")
+    expected = <<-EOS
+<div class="source-code">
+<pre class="source">foo
+bar
+
+buz
+</pre>
+<p class="caption">foo/bar/test.rb</p>
+</div>
 EOS
     assert_equal expected, actual
   end
@@ -1257,6 +1332,18 @@ EOS
 bar
 </pre>
 </div>
+EOS
+    assert_equal expected, actual
+
+    @config['caption_position']['list'] = 'bottom'
+    actual = compile_block("//box[FOO]{\nfoo\nbar\n//}\n")
+    expected = <<-EOS
+<div class="syntax">
+<pre class="syntax">foo
+bar
+</pre>
+<p class="caption">FOO</p>
+</div>
 EOS
     assert_equal expected, actual
   end
@@ -1301,6 +1388,18 @@ EOS
 lineB
 </pre>
 </div>
+EOS
+    assert_equal expected, actual
+
+    @config['caption_position']['list'] = 'bottom'
+    actual = compile_block("//emlist[cap1]{\nlineA\nlineB\n//}\n")
+    expected = <<-EOS
+<div class="emlist-code">
+<pre class="emlist">lineA
+lineB
+</pre>
+<p class="caption">cap1</p>
+</div>
 EOS
     assert_equal expected, actual
   end
@@ -1341,6 +1440,18 @@ EOS
  2: lineB
 </pre>
 </div>
+EOS
+    assert_equal expected, actual
+
+    @config['caption_position']['list'] = 'bottom'
+    actual = compile_block("//emlistnum[cap][text]{\nlineA\nlineB\n//}\n")
+    expected = <<-EOS
+<div class="emlistnum-code">
+<pre class="emlist language-text"> 1: lineA
+ 2: lineB
+</pre>
+<p class="caption">cap</p>
+</div>
 EOS
     assert_equal expected, actual
   end
@@ -1413,6 +1524,18 @@ EOS
 lineB
 </pre>
 </div>
+EOS
+    assert_equal expected, actual
+
+    @config['caption_position']['list'] = 'bottom'
+    actual = compile_block("//cmd[cap1]{\nlineA\nlineB\n//}\n")
+    expected = <<-EOS
+<div class="cmd-code">
+<pre class="cmd">lineA
+lineB
+</pre>
+<p class="caption">cap1</p>
+</div>
 EOS
     assert_equal expected, actual
   end
@@ -2074,6 +2197,19 @@ EOS
 <tr><td>ccc</td><td>ddd&lt;&gt;&amp;</td></tr>
 </table>
 </div>
+EOS
+    assert_equal expected, actual
+
+    @config['caption_position']['table'] = 'bottom'
+    actual = compile_block("//table[foo][FOO]{\naaa\tbbb\n------------\nccc\tddd<>&\n//}\n")
+    expected = <<-EOS
+<div id="foo" class="table">
+<table>
+<tr><th>aaa</th><th>bbb</th></tr>
+<tr><td>ccc</td><td>ddd&lt;&gt;&amp;</td></tr>
+</table>
+<p class="caption">表1.1: FOO</p>
+</div>
 EOS
     assert_equal expected, actual
   end
@@ -2110,6 +2246,25 @@ EOS
 <tr><td>ccc</td><td>ddd&lt;&gt;&amp;</td></tr>
 </table>
 </div>
+EOS
+    assert_equal expected, actual
+
+    @config['caption_position']['table'] = 'bottom'
+    actual = compile_block("//emtable[foo]{\naaa\tbbb\n------------\nccc\tddd<>&\n//}\n//emtable{\naaa\tbbb\n------------\nccc\tddd<>&\n//}\n")
+    expected = <<-EOS
+<div class="table">
+<table>
+<tr><th>aaa</th><th>bbb</th></tr>
+<tr><td>ccc</td><td>ddd&lt;&gt;&amp;</td></tr>
+</table>
+<p class="caption">foo</p>
+</div>
+<div class="table">
+<table>
+<tr><th>aaa</th><th>bbb</th></tr>
+<tr><td>ccc</td><td>ddd&lt;&gt;&amp;</td></tr>
+</table>
+</div>
 EOS
     assert_equal expected, actual
   end
@@ -2127,6 +2282,16 @@ EOS
 <p class="caption">表1.1: test for imgtable</p>
 <img src="images/chap1-sampleimg.png" alt="test for imgtable" />
 </div>
+EOS
+    assert_equal expected, actual
+
+    @config['caption_position']['table'] = 'bottom'
+    actual = compile_block("//imgtable[sampleimg][test for imgtable]{\n//}\n")
+    expected = <<-EOS
+<div id="sampleimg" class="imgtable image">
+<img src="images/chap1-sampleimg.png" alt="test for imgtable" />
+<p class="caption">表1.1: test for imgtable</p>
+</div>
 EOS
     assert_equal expected, actual
   end
@@ -2383,6 +2548,20 @@ EOS
 </pre>
 </div>
 </div>
+EOS
+    actual = compile_block(src)
+    assert_equal expected, actual
+
+    @config['caption_position']['equation'] = 'bottom'
+    expected = <<-EOS
+<p><span class="eqref">式1.1</span></p>
+<div id="emc2" class="caption-equation">
+<div class="equation">
+<pre>e=mc^2
+</pre>
+</div>
+<p class="caption">式1.1: The Equivalence of Mass <i>and</i> Energy</p>
+</div>
 EOS
     actual = compile_block(src)
     assert_equal expected, actual