review 2.4.0 → 2.5.0

data/lib/review/catalog.rb

@@ -48,5 +48,35 @@ module ReVIEW
       return '' unless @yaml['POSTDEF']
       @yaml['POSTDEF'].join("\n")
     end
+
+    def validate!(basedir)
+      filenames = []
+      if predef.present?
+        filenames.concat(predef.split(/\n/))
+      end
+      parts_with_chaps.each do |chap|
+        if chap.is_a?(Hash)
+          chap.each_key do |part|
+            if File.extname(part) == '.re'
+              filenames.push(part)
+            end
+          end
+          filenames.concat(chap.values.flatten)
+        else
+          filenames.push(chap)
+        end
+      end
+      if appendix.present?
+        filenames.concat(appendix.split(/\n/))
+      end
+      if postdef.present?
+        filenames.concat(postdef.split(/\n/))
+      end
+      filenames.each do |filename|
+        unless File.exist?(File.join(basedir, filename))
+          raise FileNotFound, "file not found in catalog.yml: #{basedir}/#{filename}"
+        end
+      end
+    end
   end
 end

data/lib/review/compiler.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2009-2017 Minero Aoki, Kenshi Muto
+# Copyright (c) 2009-2018 Minero Aoki, Kenshi Muto
 # Copyright (c) 2002-2007 Minero Aoki
 #
 # This program is free software.
@@ -59,8 +59,12 @@ module ReVIEW
       attr_reader :name
 
       def check_args(args)
-        raise CompileError, "wrong # of parameters (block command //#{@name}, expect #{@argc_spec} but #{args.size})" unless @argc_spec === args.size
-        @checker.call(*args) if @checker
+        unless @argc_spec === args.size
+          raise CompileError, "wrong # of parameters (block command //#{@name}, expect #{@argc_spec} but #{args.size})"
+        end
+        if @checker
+          @checker.call(*args)
+        end
       end
 
       def min_argc
@@ -161,7 +165,7 @@ module ReVIEW
 
     defsingle :footnote, 2
     defsingle :noindent, 0
-    defsingle :linebreak, 0
+    defsingle :blankline, 0
     defsingle :pagebreak, 0
     defsingle :hr, 0
     defsingle :parasep, 0
@@ -286,19 +290,29 @@ module ReVIEW
       index = level - 1
       if tag
         if tag !~ %r{\A/}
-          warn 'headline is empty.' if caption.empty?
+          if caption.empty?
+            warn 'headline is empty.'
+          end
           close_current_tagged_section(level)
           open_tagged_section(tag, level, label, caption)
         else
           open_tag = tag[1..-1]
           prev_tag_info = @tagged_section.pop
-          error "#{open_tag} is not opened." if prev_tag_info.nil? || prev_tag_info.first != open_tag
+          if prev_tag_info.nil? || prev_tag_info.first != open_tag
+            error "#{open_tag} is not opened."
+          end
           close_tagged_section(*prev_tag_info)
         end
       else
-        warn 'headline is empty.' if caption.empty?
-        @headline_indexs = @headline_indexs[0..index] if @headline_indexs.size > (index + 1)
-        @headline_indexs[index] = 0 if @headline_indexs[index].nil?
+        if caption.empty?
+          warn 'headline is empty.'
+        end
+        if @headline_indexs.size > (index + 1)
+          @headline_indexs = @headline_indexs[0..index]
+        end
+        if @headline_indexs[index].nil?
+          @headline_indexs[index] = 0
+        end
         @headline_indexs[index] += 1
         close_current_tagged_section(level)
         @strategy.headline level, label, caption
@@ -340,7 +354,9 @@ module ReVIEW
     end
 
     def close_all_tagged_section
-      close_tagged_section(* @tagged_section.pop) until @tagged_section.empty?
+      until @tagged_section.empty?
+        close_tagged_section(* @tagged_section.pop)
+      end
     end
 
     def compile_ulist(f)
@@ -349,7 +365,9 @@ module ReVIEW
         next if line =~ /\A\#@/
 
         buf = [text(line.sub(/\*+/, '').strip)]
-        f.while_match(/\A\s+(?!\*)\S/) { |cont| buf.push text(cont.strip) }
+        f.while_match(/\A\s+(?!\*)\S/) do |cont|
+          buf.push text(cont.strip)
+        end
 
         line =~ /\A\s+(\*+)/
         current_level = $1.size
@@ -392,7 +410,9 @@ module ReVIEW
 
         num = line.match(/(\d+)\./)[1]
         buf = [text(line.sub(/\d+\./, '').strip)]
-        f.while_match(/\A\s+(?!\d+\.)\S/) { |cont| buf.push text(cont.strip) }
+        f.while_match(/\A\s+(?!\d+\.)\S/) do |cont|
+          buf.push text(cont.strip)
+        end
         @strategy.ol_item buf, num
       end
       @strategy.ol_end
@@ -402,7 +422,8 @@ module ReVIEW
       @strategy.dl_begin
       while /\A\s*:/ =~ f.peek
         @strategy.dt text(f.gets.sub(/\A\s*:/, '').strip)
-        @strategy.dd(f.break(/\A(\S|\s*:|\s+\d+\.\s|\s+\*\s)/).map { |line| text(line.strip) })
+        desc = f.break(/\A(\S|\s*:|\s+\d+\.\s|\s+\*\s)/).map { |line| text(line.strip) }
+        @strategy.dd(desc)
         f.skip_blank_lines
         f.skip_comment_lines
       end
@@ -423,8 +444,9 @@ module ReVIEW
       name = line.slice(/[a-z]+/).to_sym
       ignore_inline = (name == :embed)
       args = parse_args(line.sub(%r{\A//[a-z]+}, '').rstrip.chomp('{'), name)
+      @strategy.doc_status[name] = true
       lines = block_open?(line) ? read_block(f, ignore_inline) : nil
-
+      @strategy.doc_status[name] = nil
       [name, args, lines]
     end
 
@@ -483,7 +505,9 @@ module ReVIEW
       if syntax.block_allowed?
         compile_block syntax, args, lines
       else
-        error "block is not allowed for command //#{syntax.name}; ignore" if lines
+        if lines
+          error "block is not allowed for command //#{syntax.name}; ignore"
+        end
         compile_single syntax, args
       end
     end
@@ -497,7 +521,9 @@ module ReVIEW
     end
 
     def default_block(syntax)
-      error "block is required for //#{syntax.name}; use empty block" if syntax.block_required?
+      if syntax.block_required?
+        error "block is required for //#{syntax.name}; use empty block"
+      end
       []
     end
 
@@ -516,7 +542,11 @@ module ReVIEW
     def text(str)
       return '' if str.empty?
       words = replace_fence(str).split(/(@<\w+>\{(?:[^\}\\]|\\.)*?\})/, -1)
-      words.each { |w| error "`@<xxx>' seen but is not valid inline op: #{w}" if w.scan(/@<\w+>/).size > 1 && !/\A@<raw>/.match(w) }
+      words.each do |w|
+        if w.scan(/@<\w+>/).size > 1 && !/\A@<raw>/.match(w)
+          error "`@<xxx>' seen but is not valid inline op: #{w}"
+        end
+      end
       result = @strategy.nofunc_text(words.shift)
       until words.empty?
         result << compile_inline(words.shift.gsub(/\\\}/, '}').gsub(/\\\\/, '\\'))
@@ -530,8 +560,12 @@ module ReVIEW
 
     def compile_inline(str)
       op, arg = /\A@<(\w+)>\{(.*?)\}\z/.match(str).captures
-      raise CompileError, "no such inline op: #{op}" unless inline_defined?(op)
-      raise "strategy does not support inline op: @<#{op}>" unless @strategy.respond_to?("inline_#{op}")
+      unless inline_defined?(op)
+        raise CompileError, "no such inline op: #{op}"
+      end
+      unless @strategy.respond_to?("inline_#{op}")
+        raise "strategy does not support inline op: @<#{op}>"
+      end
       @strategy.__send__("inline_#{op}", arg)
     rescue => err
       error err.message

data/lib/review/configure.rb

@@ -53,23 +53,24 @@ module ReVIEW
         'ext' => '.re',
         'image_dir' => 'images',
         'image_types' => %w[.ai .psd .eps .pdf .tif .tiff .png .bmp .jpg .jpeg .gif .svg],
-        'image_scale2width' => true, # for LaTeX
         'bib_file' => 'bib.re',
         'colophon_order' => %w[aut csl trl dsr ill cov edt pbl contact prt],
         'externallink' => true,
-        'tableopt' => nil,      # for IDGXML
-        'listinfo' => nil,      # for IDGXML
-        'nolf' => true,         # for IDGXML
-        'chapref' => nil,       # for IDGXML
-        'structuredxml' => nil, # for IDGXML
-        'pt_to_mm_unit' => 0.3528, # for IDGXML (DTP: 1pt = 0.3528mm, JIS: 1pt = 0.3514mm)
-
-        'footnotetext' => nil, # for LaTeX
-        'texcommand' => 'uplatex', # for LaTeX
-        'texdocumentclass' => ['jsbook', 'uplatex,oneside'], # for LaTeX
-        'dvicommand' => 'dvipdfmx', # for LaTeX
-        'dvioptions' => '-d 5', # for LaTeX
-
+        # for IDGXML
+        'tableopt' => nil,
+        'listinfo' => nil,
+        'nolf' => true,
+        'chapref' => nil,
+        'structuredxml' => nil,
+        'pt_to_mm_unit' => 0.3528, # DTP: 1pt = 0.3528mm, JIS: 1pt = 0.3514mm
+        # for LaTeX
+        'image_scale2width' => true,
+        'footnotetext' => nil,
+        'texcommand' => 'uplatex',
+        'texdocumentclass' => ['jsbook', 'uplatex,oneside'],
+        'dvicommand' => 'dvipdfmx',
+        'dvioptions' => '-d 5',
+        # for PDFMaker
         'pdfmaker' => {
           'makeindex' => nil, # Make index page
           'makeindex_command' => 'mendex', # works only when makeindex is true

data/lib/review/epubmaker.rb

@@ -50,7 +50,13 @@ module ReVIEW
 
     def load_yaml(yamlfile)
       loader = ReVIEW::YAMLLoader.new
-      @config = ReVIEW::Configure.values.deep_merge(loader.load_file(yamlfile))
+      @config = ReVIEW::Configure.values
+      begin
+        @config.deep_merge!(loader.load_file(yamlfile))
+      rescue => e
+        error "yaml error #{e.message}"
+      end
+
       @producer = Producer.new(@config)
       @producer.load(yamlfile)
       @config = @producer.config
@@ -134,8 +140,11 @@ module ReVIEW
         log('Call ePUB producer.')
         @producer.produce("#{bookname}.epub", basetmpdir, epubtmpdir)
         log('Finished.')
+      rescue ApplicationError => e
+        raise if @config['debug']
+        error(e.message)
       ensure
-        FileUtils.remove_entry_secure basetmpdir unless @config['debug']
+        FileUtils.remove_entry_secure(basetmpdir) unless @config['debug']
       end
     end
 
@@ -364,7 +373,8 @@ module ReVIEW
     def write_info_body(basetmpdir, _id, filename, ispart = nil, chaptype = nil)
       headlines = []
       path = File.join(basetmpdir, filename)
-      Document.parse_stream(File.new(path), ReVIEWHeaderListener.new(headlines))
+      htmlio = File.new(path)
+      Document.parse_stream(htmlio, ReVIEWHeaderListener.new(headlines))
       properties = detect_properties(path)
       prop_str = ''
       prop_str = ',properties=' + properties.join(' ') if properties.present?
@@ -378,6 +388,7 @@ module ReVIEW
           first = nil
         end
       end
+      htmlio.close
     end
 
     def push_contents(_basetmpdir)
@@ -435,7 +446,7 @@ module ReVIEW
         @body << %Q(<h1 class="tp-title">#{CGI.escapeHTML(@config.name_of('booktitle'))}</h1>\n)
         @body << %Q(<h2 class="tp-subtitle">#{CGI.escapeHTML(@config.name_of('subtitle'))}</h2>\n) if @config['subtitle']
         @body << %Q(<h2 class="tp-author">#{CGI.escapeHTML(@config.names_of('aut').join(ReVIEW::I18n.t('names_splitter')))}</h2>\n) if @config['aut']
-        @body << %Q(<h3 class="tp-publisher">#{CGI.escapeHTML(@config.names_of('prt').join(ReVIEW::I18n.t('names_splitter')))}</h3>\n) if @config['prt']
+        @body << %Q(<h3 class="tp-publisher">#{CGI.escapeHTML(@config.names_of('pbl').join(ReVIEW::I18n.t('names_splitter')))}</h3>\n) if @config['pbl']
         @body << '</div>'
 
         @language = @producer.config['language']

data/lib/review/htmlbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2017 Minero Aoki, Kenshi Muto, Masayoshi Takahashi,
+# Copyright (c) 2008-2018 Minero Aoki, Kenshi Muto, Masayoshi Takahashi,
 #                         KADO Masanori
 #               2002-2007 Minero Aoki
 #
@@ -20,7 +20,9 @@ module ReVIEW
     include TextUtils
     include HTMLUtils
 
-    [:ref].each { |e| Compiler.definline(e) }
+    [:ref].each do |e|
+      Compiler.definline(e)
+    end
     Compiler.defblock(:planning, 0..1)
     Compiler.defblock(:best, 0..1)
     Compiler.defblock(:security, 0..1)
@@ -101,7 +103,9 @@ module ReVIEW
       @next_title = @next ? compile_inline(@next.title) : ''
       @prev_title = @prev ? compile_inline(@prev.title) : ''
 
-      @toc = ReVIEW::WEBTOCPrinter.book_to_string(@book) if @book.config.maker == 'webmaker'
+      if @book.config.maker == 'webmaker'
+        @toc = ReVIEW::WEBTOCPrinter.book_to_string(@book)
+      end
 
       ReVIEW::Template.load(layoutfile).result(binding)
     end
@@ -116,10 +120,14 @@ module ReVIEW
 
     def headline(level, label, caption)
       prefix, anchor = headline_prefix(level)
-      prefix = %Q(<span class="secno">#{prefix}</span>) if prefix
+      if prefix
+        prefix = %Q(<span class="secno">#{prefix}</span>)
+      end
       puts '' if level > 1
       a_id = ''
-      a_id = %Q(<a id="h#{anchor}"></a>) if anchor
+      if anchor
+        a_id = %Q(<a id="h#{anchor}"></a>)
+      end
 
       if caption.empty?
         puts a_id if label
@@ -282,7 +290,9 @@ module ReVIEW
       puts %Q(<div class="syntax">)
       puts %Q(<p class="caption">#{compile_inline(caption)}</p>) if caption.present?
       print %Q(<pre class="syntax">)
-      lines.each { |line| puts detab(line) }
+      lines.each do |line|
+        puts detab(line)
+      end
       puts '</pre>'
       puts '</div>'
     end
@@ -435,7 +445,9 @@ module ReVIEW
         class_names.push('highlight') if highlight?
         print %Q(<pre class="#{class_names.join(' ')}">)
         first_line_num = line_num
-        lines.each_with_index { |line, i| puts detab((i + first_line_num).to_s.rjust(2) + ': ' + line) }
+        lines.each_with_index do |line, i|
+          puts detab((i + first_line_num).to_s.rjust(2) + ': ' + line)
+        end
         puts '</pre>'
       end
     end
@@ -470,7 +482,9 @@ module ReVIEW
         class_names.push('highlight') if highlight?
         print %Q(<pre class="#{class_names.join(' ')}">)
         first_line_num = line_num
-        lines.each_with_index { |line, i| puts detab((i + first_line_num).to_s.rjust(2) + ': ' + line) }
+        lines.each_with_index do |line, i|
+          puts detab((i + first_line_num).to_s.rjust(2) + ': ' + line)
+        end
         puts '</pre>'
       end
 
@@ -490,7 +504,9 @@ module ReVIEW
 
     def quotedlist(lines, css_class)
       print %Q(<blockquote><pre class="#{css_class}">)
-      lines.each { |line| puts detab(line) }
+      lines.each do |line|
+        puts detab(line)
+      end
       puts '</pre></blockquote>'
     end
     private :quotedlist
@@ -541,7 +557,9 @@ module ReVIEW
     end
 
     def handle_metric(str)
-      return { 'class' => sprintf('width-%03dper', ($1.to_f * 100).round) } if str =~ /\Ascale=([\d.]+)\Z/
+      if str =~ /\Ascale=([\d.]+)\Z/
+        return { 'class' => sprintf('width-%03dper', ($1.to_f * 100).round) }
+      end
 
       k, v = str.split('=', 2)
       { k => v.sub(/\A["']/, '').sub(/["']\Z/, '') }
@@ -572,7 +590,9 @@ module ReVIEW
       warn "image not bound: #{id}"
       puts %Q(<div id="#{normalize_id(id)}" class="image">)
       puts %Q(<pre class="dummyimage">)
-      lines.each { |line| puts detab(line) }
+      lines.each do |line|
+        puts detab(line)
+      end
       puts '</pre>'
       image_header id, caption
       puts '</div>'
@@ -615,8 +635,12 @@ module ReVIEW
       table_begin rows.first.size
       return if rows.empty?
       if sepidx
-        sepidx.times { tr(rows.shift.map { |s| th(s) }) }
-        rows.each { |cols| tr(cols.map { |s| td(s) }) }
+        sepidx.times do
+          tr(rows.shift.map { |s| th(s) })
+        end
+        rows.each do |cols|
+          tr(cols.map { |s| td(s) })
+        end
       else
         rows.each do |cols|
           h, *cs = *cols
@@ -711,7 +735,9 @@ module ReVIEW
         warn "image not bound: #{id}"
         if lines
           puts %Q(<pre class="dummyimage">)
-          lines.each { |line| puts detab(line) }
+          lines.each do |line|
+            puts detab(line)
+          end
           puts '</pre>'
         end
       end
@@ -734,8 +760,8 @@ module ReVIEW
       puts %Q(<a id="#{normalize_id(id)}"></a>)
     end
 
-    def linebreak
-      puts '<br />'
+    def blankline
+      puts '<p><br /></p>'
     end
 
     def pagebreak
@@ -744,7 +770,9 @@ module ReVIEW
 
     def bpo(lines)
       puts '<bpo>'
-      lines.each { |line| puts detab(line) }
+      lines.each do |line|
+        puts detab(line)
+      end
       puts '</bpo>'
     end
 
@@ -771,7 +799,6 @@ module ReVIEW
       end
     rescue KeyError
       error "unknown chapter: #{id}"
-      nofunc_text("[UnknownChapter:#{id}]")
     end
 
     def inline_chap(id)
@@ -782,7 +809,6 @@ module ReVIEW
       end
     rescue KeyError
       error "unknown chapter: #{id}"
-      nofunc_text("[UnknownChapter:#{id}]")
     end
 
     def inline_title(id)
@@ -794,7 +820,6 @@ module ReVIEW
       end
     rescue KeyError
       error "unknown chapter: #{id}"
-      nofunc_text("[UnknownChapter:#{id}]")
     end
 
     def inline_fn(id)
@@ -803,6 +828,8 @@ module ReVIEW
       else
         %Q(<a id="fnb-#{normalize_id(id)}" href="#fn-#{normalize_id(id)}" class="noteref">*#{@chapter.footnote(id).number}</a>)
       end
+    rescue KeyError
+      error "unknown footnote: #{id}"
     end
 
     def compile_ruby(base, ruby)
@@ -921,6 +948,8 @@ module ReVIEW
 
     def inline_bib(id)
       %Q(<a href="#{@book.bib_file.gsub(/\.re\Z/, ".#{@book.config['htmlext']}")}#bib-#{normalize_id(id)}">[#{@chapter.bibpaper(id).number}]</a>)
+    rescue KeyError
+      error "unknown bib: #{id}"
     end
 
     def inline_hd_chap(chap, id)
@@ -936,6 +965,8 @@ module ReVIEW
       else
         str
       end
+    rescue KeyError
+      error "unknown headline: #{id}"
     end
 
     def column_label(id, chapter = @chapter)
@@ -950,6 +981,8 @@ module ReVIEW
       else
         I18n.t('column', compile_inline(chapter.column(id).caption))
       end
+    rescue KeyError
+      error "unknown column: #{id}"
     end
 
     def inline_list(id)
@@ -967,7 +1000,6 @@ module ReVIEW
       end
     rescue KeyError
       error "unknown list: #{id}"
-      nofunc_text("[UnknownList:#{id}]")
     end
 
     def inline_table(id)
@@ -985,7 +1017,6 @@ module ReVIEW
       end
     rescue KeyError
       error "unknown table: #{id}"
-      nofunc_text("[UnknownTable:#{id}]")
     end
 
     def inline_img(id)
@@ -1003,7 +1034,6 @@ module ReVIEW
       end
     rescue KeyError
       error "unknown image: #{id}"
-      nofunc_text("[UnknownImage:#{id}]")
     end
 
     def inline_asis(str, tag)
@@ -1110,7 +1140,9 @@ module ReVIEW
     def inline_tcy(str)
       # 縦中横用のtcy、uprightのCSSスタイルについては電書協ガイドラインを参照
       style = 'tcy'
-      style = 'upright' if str.size == 1 && str.match(/[[:ascii:]]/)
+      if str.size == 1 && str.match(/[[:ascii:]]/)
+        style = 'upright'
+      end
       %Q(<span class="#{style}">#{escape_html(str)}</span>)
     end