review 2.4.0 → 2.5.0

data/lib/review/version.rb

@@ -1,3 +1,3 @@
 module ReVIEW
-  VERSION = '2.4.0'.freeze
+  VERSION = '2.5.0'.freeze
 end

data/lib/review/webmaker.rb

@@ -13,6 +13,7 @@ require 'review/converter'
 require 'review/configure'
 require 'review/book'
 require 'review/htmlbuilder'
+require 'review/yamlloader'
 require 'review/template'
 require 'review/tocprinter'
 require 'review/version'
@@ -29,6 +30,15 @@ module ReVIEW
       @logger = ReVIEW.logger
     end
 
+    def error(msg)
+      @logger.error "#{File.basename($PROGRAM_NAME, '.*')}: #{msg}"
+      exit 1
+    end
+
+    def warn(msg)
+      @logger.warn "#{File.basename($PROGRAM_NAME, '.*')}: #{msg}"
+    end
+
     def self.execute(*args)
       self.new.execute(*args)
     end
@@ -68,13 +78,24 @@ module ReVIEW
       @config = ReVIEW::Configure.values
       @config.maker = 'webmaker'
       cmd_config, yamlfile = parse_opts(args)
+      error "#{yamlfile} not found." unless File.exist?(yamlfile)
 
-      @config.merge!(YAML.load_file(yamlfile))
+      begin
+        loader = ReVIEW::YAMLLoader.new
+        @config.deep_merge!(loader.load_file(yamlfile))
+      rescue => e
+        error "yaml error #{e.message}"
+      end
       # YAML configs will be overridden by command line options.
-      @config.merge!(cmd_config)
+      @config.deep_merge!(cmd_config)
       @config['htmlext'] = 'html'
       I18n.setup(@config['language'])
-      generate_html_files(yamlfile)
+      begin
+        generate_html_files(yamlfile)
+      rescue ApplicationError => e
+        raise if @config['debug']
+        error(e.message)
+      end
     end
 
     def generate_html_files(yamlfile)
@@ -154,14 +175,14 @@ module ReVIEW
       htmlfile = "#{id}.#{@config['htmlext']}"
 
       if @config['params'].present?
-        @logger.warn %Q('params:' in config.yml is obsoleted.)
+        warn %Q('params:' in config.yml is obsoleted.)
       end
 
       begin
         @converter.convert(filename, File.join(basetmpdir, htmlfile))
       rescue => e
-        @logger.warn "compile error in #{filename} (#{e.class})"
-        @logger.warn e.message
+        warn "compile error in #{filename} (#{e.class})"
+        warn e.message
       end
     end
 
@@ -240,7 +261,7 @@ module ReVIEW
         @body << %Q(<div class="titlepage">)
         @body << %Q(<h1 class="tp-title">#{CGI.escapeHTML(@config.name_of('booktitle'))}</h1>)
         @body << %Q(<h2 class="tp-author">#{join_with_separator(@config.names_of('aut'), ReVIEW::I18n.t('names_splitter'))}</h2>) if @config['aut']
-        @body << %Q(<h3 class="tp-publisher">#{join_with_separator(@config.names_of('prt'), ReVIEW::I18n.t('names_splitter'))}</h3>) if @config['prt']
+        @body << %Q(<h3 class="tp-publisher">#{join_with_separator(@config.names_of('pbl'), ReVIEW::I18n.t('names_splitter'))}</h3>) if @config['pbl']
         @body << '</div>'
 
         @language = @config['language']
@@ -262,7 +283,7 @@ module ReVIEW
     def copy_file_with_param(name, target_file = nil)
       return if @config[name].nil? || !File.exist?(@config[name])
       target_file ||= File.basename(@config[name])
-      FileUtils.cp(@config[name], File.join(basetmpdir, target_file))
+      FileUtils.cp(@config[name], File.join(@path, target_file))
     end
 
     def join_with_separator(value, sep)

data/review.gemspec

@@ -12,13 +12,12 @@ 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 = '2017-06-29'
+  gem.date = '2018-03-01'
 
   gem.files         = `git ls-files`.split("\n")
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
-  gem.extra_rdoc_files = [
-  ]
+  gem.extra_rdoc_files = []
   gem.require_paths = ['lib']
 
   gem.add_dependency('image_size')
@@ -26,6 +25,6 @@ Gem::Specification.new do |gem|
   gem.add_dependency('rubyzip')
   gem.add_development_dependency('pygments.rb')
   gem.add_development_dependency('rake')
-  gem.add_development_dependency('rubocop')
+  gem.add_development_dependency('rubocop', '~> 0.52.0')
   gem.add_development_dependency('test-unit')
 end

data/templates/html/layout-xhtml1.html.erb

@@ -13,8 +13,6 @@
   <title><%= @title %></title>
 </head>
 <body<%= @body_ext %>>
-<% if @error_messages   %><%= @error_messages   %><% end %>
-<% if @warning_messages %><%= @warning_messages %><% end %>
 <%= @body %>
 </body>
 </html>

data/templates/latex/layout.tex.erb

@@ -249,8 +249,10 @@
 }
 \makeatother
 
-<%- if @config["usepackage"] -%>
-<%= @config["usepackage"] %>
+<%- if @config["texstyle"] -%>
+<%-   [@config["texstyle"]].flatten.each do |x| -%>
+\usepackage{<%= x %>}
+<%-   end -%>
 <%- end -%>
 <%- if @config["makeindex"] -%>
 \usepackage{makeidx}
@@ -360,7 +362,7 @@
 <%- if @config["subtitle"] -%>
 {\noindent\reviewtitlefont\large <%= escape_latex(@config.name_of("subtitle")) %>} \\
 <%- end -%>
-\rule[8pt]{14cm}{1pt} \\
+\rule[8pt]{\textwidth}{1pt} \\
 {\noindent
 <%= @config["pubhistory"].to_s.gsub(/\n/){"\n\n\\noindent\n"} %>
 }
@@ -369,7 +371,7 @@
 <%= @okuduke %>
 \end{tabular}
 　\\
-\rule[0pt]{14cm}{1pt} \\
+\rule[0pt]{\textwidth}{1pt} \\
 <%-     if @config["rights"] -%>
 <%= @config.names_of("rights").map{|s| escape_latex(s)}.join('\\' + '\\') %> \\
 <%-     end -%>

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

@@ -13,8 +13,6 @@
   <title><%= @title %></title>
 </head>
 <body<%= @body_ext %>>
-<% if @error_messages   %><%= @error_messages   %><% end %>
-<% if @warning_messages %><%= @warning_messages %><% end %>
 <%= @body %>
 </body>
 </html>

data/test/book_test_helper.rb

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'book_test_helper'
 require 'review/book'
 
 require 'stringio'

data/test/run_test.rb

@@ -6,5 +6,5 @@ $LOAD_PATH.unshift(lib_dir)
 
 require 'test/unit'
 
-argv = ['--max-diff-target-string-size=10000']
+argv = ARGV || ['--max-diff-target-string-size=10000']
 exit Test::Unit::AutoRunner.run(true, test_dir, argv)

data/test/sample-book/src/Rakefile

@@ -6,10 +6,12 @@ BOOK_PDF = BOOK + '.pdf'
 BOOK_EPUB = BOOK + '.epub'
 CONFIG_FILE = 'config.yml'
 WEBROOT = 'webroot'
+TEXTROOT = BOOK + '-text'
+TOPROOT = BOOK + '-text'
 
 def build(mode, chapter)
   sh "review-compile --target=#{mode} --footnotetext --stylesheet=style.css #{chapter} > tmp"
-  mode_ext = { 'html' => 'html', 'latex' => 'tex', 'idgxml' => 'xml' }
+  mode_ext = { 'html' => 'html', 'latex' => 'tex', 'idgxml' => 'xml', 'top' => 'txt', 'plaintext' => 'txt' }
   FileUtils.mv 'tmp', chapter.gsub(/re\z/, mode_ext[mode])
 end
 
@@ -46,9 +48,19 @@ task all: %i[pdf epub]
 desc 'generate PDF file'
 task pdf: BOOK_PDF
 
-desc 'generate stagic HTML file for web'
+desc 'generate static HTML file for web'
 task web: WEBROOT
 
+desc 'generate text file (without decoration)'
+task plaintext: TEXTROOT do
+  sh "review-textmaker -n #{CONFIG_FILE}"
+end
+
+desc 'generate (decorated) text file'
+task text: TOPROOT do
+  sh "review-textmaker #{CONFIG_FILE}"
+end
+
 desc 'generate EPUB file'
 task epub: BOOK_EPUB
 
@@ -69,4 +81,8 @@ file WEBROOT => SRC do
   sh "review-webmaker #{CONFIG_FILE}"
 end
 
-CLEAN.include([BOOK, BOOK_PDF, BOOK_EPUB, BOOK + '-pdf', BOOK + '-epub', WEBROOT, 'images/_review_math'])
+file TEXTROOT => SRC do
+  FileUtils.rm_rf [TEXTROOT]
+end
+
+CLEAN.include([BOOK, BOOK_PDF, BOOK_EPUB, BOOK + '-pdf', BOOK + '-epub', WEBROOT, 'images/_review_math', TEXTROOT])

data/test/syntax-book/Rakefile

@@ -6,10 +6,12 @@ BOOK_PDF = BOOK + '.pdf'
 BOOK_EPUB = BOOK + '.epub'
 CONFIG_FILE = 'config.yml'
 WEBROOT = 'webroot'
+TEXTROOT = BOOK + '-text'
+TOPROOT = BOOK + '-text'
 
 def build(mode, chapter)
   sh "review-compile --target=#{mode} --footnotetext --stylesheet=style.css #{chapter} > tmp"
-  mode_ext = { 'html' => 'html', 'latex' => 'tex', 'idgxml' => 'xml' }
+  mode_ext = { 'html' => 'html', 'latex' => 'tex', 'idgxml' => 'xml', 'top' => 'txt', 'plaintext' => 'txt' }
   FileUtils.mv 'tmp', chapter.gsub(/re\z/, mode_ext[mode])
 end
 
@@ -46,9 +48,19 @@ task all: %i[pdf epub]
 desc 'generate PDF file'
 task pdf: BOOK_PDF
 
-desc 'generate stagic HTML file for web'
+desc 'generate static HTML file for web'
 task web: WEBROOT
 
+desc 'generate plaintext file'
+task plaintext: TEXTROOT do
+  sh "review-textmaker -n #{CONFIG_FILE}"
+end
+
+desc 'generate decorated text file'
+task text: TOPROOT do
+  sh "review-textmaker #{CONFIG_FILE}"
+end
+
 desc 'generate EPUB file'
 task epub: BOOK_EPUB
 
@@ -69,4 +81,8 @@ file WEBROOT => SRC do
   sh "review-webmaker #{CONFIG_FILE}"
 end
 
-CLEAN.include([BOOK, BOOK_PDF, BOOK_EPUB, BOOK + '-pdf', BOOK + '-epub', WEBROOT])
+file TEXTROOT => SRC do
+  FileUtils.rm_rf [TEXTROOT]
+end
+
+CLEAN.include([BOOK, BOOK_PDF, BOOK_EPUB, BOOK + '-pdf', BOOK + '-epub', WEBROOT, 'images/_review_math', TEXTROOT])

data/test/test_catalog.rb

@@ -3,6 +3,7 @@ require 'review/catalog'
 
 class CatalogTest < Test::Unit::TestCase
   include ReVIEW
+  include BookTestHelper
 
   def test_predef
     sut = Catalog.new(yaml)
@@ -90,6 +91,50 @@ ch02.re
     assert_equal(exp.chomp, sut.chaps)
   end
 
+  def test_validate
+    mktmpbookdir do |dir, _book, _files|
+      %w[pre01.re pre02.re ch01.re ch02.re post01.re post02.re back01.re back02.re].each do |file|
+        FileUtils.touch(file)
+      end
+      cat = Catalog.new(yaml_hash)
+      cat.validate!(dir)
+    end
+  end
+
+  def test_validate_with_parts
+    mktmpbookdir do |dir, _book, _files|
+      %w[ch01.re part1.re ch02.re ch03.re part2.re ch04.re ch05.re].each do |file|
+        FileUtils.touch(file)
+      end
+      cat = Catalog.new(yaml_with_parts)
+      cat.validate!(dir)
+    end
+  end
+
+  def test_validate_fail_ch02
+    assert_raise FileNotFound do
+      mktmpbookdir do |dir, _book, _files|
+        %w[pre01.re pre02.re ch01.re].each do |file|
+          FileUtils.touch(file)
+        end
+        cat = Catalog.new(yaml_hash)
+        cat.validate!(dir)
+      end
+    end
+  end
+
+  def test_validate_fail_back02
+    assert_raise FileNotFound do
+      mktmpbookdir do |dir, _book, _files|
+        %w[pre01.re pre02.re ch01.re ch02.re post01.re post02.re back01.re back03.re].each do |file|
+          FileUtils.touch(file)
+        end
+        cat = Catalog.new(yaml_hash)
+        cat.validate!(dir)
+      end
+    end
+  end
+
   private
 
   def yaml

data/test/test_compiler.rb

@@ -42,7 +42,13 @@ class CompilerTest < Test::Unit::TestCase
   end
 
   def test_replace_fence
-    actual = @c.__send__(:replace_fence, '@<m>${}\\}|$, @<m>|{}\\}\\$|, @<m>|\\{\\a\\}|, @<tt>|}|, @<tt>|\\|, @<tt>|\\\\|, @<tt>|\\\\\\|')
-    assert_equal '@<m>{{\\}\\\\\\}|}, @<m>{{\\}\\\\\\}\\$}, @<m>{\\{\\a\\\\\\}}, @<tt>{\\}}, @<tt>{\\\\}, @<tt>{\\\\\\\\}, @<tt>{\\\\\\\\\\\\}', actual
+    source_str = <<-'EOB'
+@<m>${}\}|$, @<m>|{}\}\$|, @<m>|\{\a\}|, @<tt>|}|, @<tt>|\|, @<tt>|\\|, @<tt>|\\\|
+    EOB
+    expected = <<-'EOB'
+@<m>{{\}\\\}|}, @<m>{{\}\\\}\$}, @<m>{\{\a\\\}}, @<tt>{\}}, @<tt>{\\}, @<tt>{\\\\}, @<tt>{\\\\\\}
+    EOB
+    actual = @c.__send__(:replace_fence, source_str)
+    assert_equal expected, actual
   end
 end

data/test/test_htmlbuilder.rb

@@ -430,6 +430,11 @@ EOS
     assert_equal %Q(<div class="memo">\n<p class="caption">this is <b>test</b>&lt;&amp;&gt;_</p>\n<p>test1</p>\n<p>test<i>2</i></p>\n</div>\n), actual
   end
 
+  def test_blankline
+    actual = compile_block("//blankline\nfoo\n")
+    assert_equal %Q(<p><br /></p>\n<p>foo</p>\n), actual
+  end
+
   def test_noindent
     @builder.noindent
     actual = compile_block("foo\nbar\n\nfoo2\nbar2\n")
@@ -1686,4 +1691,21 @@ EOS
     actual = compile_inline('test @<code>|@<code>{$サンプル$}|')
     assert_equal 'test <code class="inline-code tt">@&lt;code&gt;{$サンプル$}</code>', actual
   end
+
+  def test_inline_unknown
+    e = assert_raises(ReVIEW::ApplicationError) { compile_block "@<img>{n}\n" }
+    assert_equal ':1: error: unknown image: n', e.message
+    e = assert_raises(ReVIEW::ApplicationError) { compile_block "@<fn>{n}\n" }
+    assert_equal ':1: error: unknown footnote: n', e.message
+    e = assert_raises(ReVIEW::ApplicationError) { compile_block "@<hd>{n}\n" }
+    assert_equal ':1: error: unknown headline: n', e.message
+    %w[list table column].each do |name|
+      e = assert_raises(ReVIEW::ApplicationError) { compile_block "@<#{name}>{n}\n" }
+      assert_equal ":1: error: unknown #{name}: n", e.message
+    end
+    %w[chap chapref title].each do |name|
+      e = assert_raises(ReVIEW::ApplicationError) { compile_block "@<#{name}>{n}\n" }
+      assert_equal ':1: error: key not found: "n"', e.message
+    end
+  end
 end

data/test/test_idgxmlbuilder.rb

@@ -341,6 +341,11 @@ class IDGXMLBuidlerTest < Test::Unit::TestCase
     assert_equal %Q(<p align='center'>foobar</p><p align='center'>buz</p>), actual
   end
 
+  def test_blankline
+    actual = compile_block("//blankline\nfoo\n")
+    assert_equal %Q(<p/><p>foo</p>), actual
+  end
+
   def test_noindent
     actual = compile_block("//noindent\nfoo\nbar\n\nfoo2\nbar2\n")
     assert_equal %Q(<p aid:pstyle="noindent" noindent='1'>foobar</p><p>foo2bar2</p>), actual
@@ -614,6 +619,23 @@ EOS
     assert_equal expected, actual
   end
 
+  def test_inline_unknown
+    e = assert_raises(ReVIEW::ApplicationError) { compile_block "@<img>{n}\n" }
+    assert_equal ':1: error: unknown image: n', e.message
+    e = assert_raises(ReVIEW::ApplicationError) { compile_block "@<fn>{n}\n" }
+    assert_equal ':1: error: unknown footnote: n', e.message
+    e = assert_raises(ReVIEW::ApplicationError) { compile_block "@<hd>{n}\n" }
+    assert_equal ':1: error: unknown headline: n', e.message
+    %w[list table column].each do |name|
+      e = assert_raises(ReVIEW::ApplicationError) { compile_block "@<#{name}>{n}\n" }
+      assert_equal ":1: error: unknown #{name}: n", e.message
+    end
+    %w[chap chapref title].each do |name|
+      e = assert_raises(ReVIEW::ApplicationError) { compile_block "@<#{name}>{n}\n" }
+      assert_equal ':1: error: key not found: "n"', e.message
+    end
+  end
+
   def test_inline_raw0
     assert_equal 'normal', compile_inline('@<raw>{normal}')
   end

data/test/test_index.rb

@@ -177,4 +177,35 @@ class IndexTest < Test::Unit::TestCase
     index = Book::HeadlineIndex.parse(src, chap)
     assert_equal '1.1.1', index.number('sec1-1')
   end
+
+  def test_headeline_index9
+    src = <<-EOB
+= chap1
+== sec1
+=== sec1-1
+===[column] column1
+===[/column]
+==== sec1-1-1
+=== sec1-2
+    EOB
+    book = Book::Base.load
+    chap = Book::Chapter.new(book, 1, '-', nil)
+    index = Book::HeadlineIndex.parse(src, chap)
+    assert_equal [1, 1, 1], index['sec1-1-1'].number
+  end
+
+  def test_headeline_index10
+    src = <<-EOB
+= chap1
+== sec1
+=== sec1-1
+====[column] column1
+==== sec1-1-1
+=== sec1-2
+    EOB
+    book = Book::Base.load
+    chap = Book::Chapter.new(book, 1, '-', nil)
+    index = Book::HeadlineIndex.parse(src, chap)
+    assert_equal [1, 1, 1], index['sec1-1-1'].number
+  end
 end