review 2.5.0 → 3.0.0.preview1

data/lib/review/htmlbuilder.rb

@@ -14,6 +14,7 @@ require 'review/textutils'
 require 'review/webtocprinter'
 require 'digest'
 require 'tmpdir'
+require 'open3'
 
 module ReVIEW
   class HTMLBuilder < Builder
@@ -41,16 +42,13 @@ module ReVIEW
       ".#{@book.config['htmlext']}"
     end
 
-    def builder_init(no_error = false)
-      @no_error = no_error
-      @noindent = nil
-      @ol_num = nil
-      @error_messages = nil
-      @warning_messages = nil
+    def builder_init
     end
     private :builder_init
 
     def builder_init_file
+      @noindent = nil
+      @ol_num = nil
       @warns = []
       @errors = []
       @chapter.book.image_types = %w[.png .jpg .jpeg .gif .svg]
@@ -232,7 +230,9 @@ module ReVIEW
 
     def captionblock(type, lines, caption)
       puts %Q(<div class="#{type}">)
-      puts %Q(<p class="caption">#{compile_inline(caption)}</p>) if caption.present?
+      if caption.present?
+        puts %Q(<p class="caption">#{compile_inline(caption)}</p>)
+      end
       blocked_lines = split_paragraph(lines)
       puts blocked_lines.join("\n")
       puts '</div>'
@@ -288,7 +288,9 @@ module ReVIEW
 
     def box(lines, caption = nil)
       puts %Q(<div class="syntax">)
-      puts %Q(<p class="caption">#{compile_inline(caption)}</p>) if caption.present?
+      if caption.present?
+        puts %Q(<p class="caption">#{compile_inline(caption)}</p>)
+      end
       print %Q(<pre class="syntax">)
       lines.each do |line|
         puts detab(line)
@@ -389,10 +391,9 @@ module ReVIEW
       end
     end
 
-    def list_body(id, lines, lang)
-      id ||= ''
+    def list_body(_id, lines, lang)
       class_names = ['list']
-      lexer = lang || File.extname(id).gsub('.', '')
+      lexer = lang
       class_names.push("language-#{lexer}") unless lexer.blank?
       class_names.push('highlight') if highlight?
       print %Q(<pre class="#{class_names.join(' ')}">)
@@ -409,14 +410,15 @@ module ReVIEW
     end
 
     def source_header(caption)
-      puts %Q(<p class="caption">#{compile_inline(caption)}</p>) if caption.present?
+      if caption.present?
+        puts %Q(<p class="caption">#{compile_inline(caption)}</p>)
+      end
     end
 
-    def source_body(id, lines, lang)
-      id ||= ''
+    def source_body(_id, lines, lang)
       print %Q(<pre class="source">)
       body = lines.inject('') { |i, j| i + detab(j) + "\n" }
-      lexer = lang || File.extname(id).gsub('.', '')
+      lexer = lang
       puts highlight(body: body, lexer: lexer, format: 'html')
       puts '</pre>'
     end
@@ -454,7 +456,9 @@ module ReVIEW
 
     def emlist(lines, caption = nil, lang = nil)
       puts %Q(<div class="emlist-code">)
-      puts %Q(<p class="caption">#{compile_inline(caption)}</p>) if caption.present?
+      if caption.present?
+        puts %Q(<p class="caption">#{compile_inline(caption)}</p>)
+      end
       class_names = ['emlist']
       class_names.push("language-#{lang}") unless lang.blank?
       class_names.push('highlight') if highlight?
@@ -468,7 +472,9 @@ module ReVIEW
 
     def emlistnum(lines, caption = nil, lang = nil)
       puts %Q(<div class="emlistnum-code">)
-      puts %Q(<p class="caption">#{compile_inline(caption)}</p>) if caption.present?
+      if caption.present?
+        puts %Q(<p class="caption">#{compile_inline(caption)}</p>)
+      end
 
       if highlight?
         body = lines.inject('') { |i, j| i + detab(j) + "\n" }
@@ -493,7 +499,9 @@ module ReVIEW
 
     def cmd(lines, caption = nil)
       puts %Q(<div class="cmd-code">)
-      puts %Q(<p class="caption">#{compile_inline(caption)}</p>) if caption.present?
+      if caption.present?
+        puts %Q(<p class="caption">#{compile_inline(caption)}</p>)
+      end
       print %Q(<pre class="cmd">)
       body = lines.inject('') { |i, j| i + detab(j) + "\n" }
       lexer = 'shell-session'
@@ -537,17 +545,15 @@ module ReVIEW
         require 'math_ml'
         require 'math_ml/symbol/character_reference'
         p = MathML::LaTeX::Parser.new(symbol: MathML::Symbol::CharacterReference)
-        puts p.parse(unescape_html(lines.join("\n")), true)
+        puts p.parse(unescape(lines.join("\n")), true)
       elsif @book.config['imgmath']
-        puts %Q(<div class="equation">)
-        math_str = "\\begin{equation*}\n" + unescape_html(lines.join("\n")) + "\n\\end{equation*}\n"
+        math_str = "\\begin{equation*}\n" + unescape(lines.join("\n")) + "\n\\end{equation*}\n"
         key = Digest::SHA256.hexdigest(math_str)
         math_dir = "./#{@book.config['imagedir']}/_review_math"
         Dir.mkdir(math_dir) unless Dir.exist?(math_dir)
         img_path = "./#{math_dir}/_gen_#{key}.png"
         make_math_image(math_str, img_path)
         puts %Q(<img src="#{img_path}" />)
-        puts '</div>'
       else
         print '<pre>'
         puts lines.join("\n")
@@ -581,7 +587,7 @@ module ReVIEW
     def image_image(id, caption, metric)
       metrics = parse_metric('html', metric)
       puts %Q(<div id="#{normalize_id(id)}" class="image">)
-      puts %Q(<img src="#{@chapter.image(id).path.sub(%r{\A\./}, '')}" alt="#{escape_html(compile_inline(caption))}"#{metrics} />)
+      puts %Q(<img src="#{@chapter.image(id).path.sub(%r{\A\./}, '')}" alt="#{escape(compile_inline(caption))}"#{metrics} />)
       image_header id, caption
       puts '</div>'
     end
@@ -628,7 +634,9 @@ module ReVIEW
         puts %Q(<div class="table">)
       end
       begin
-        table_header id, caption if caption.present?
+        if caption.present?
+          table_header id, caption
+        end
       rescue KeyError
         error "no such table: #{id}"
       end
@@ -690,7 +698,9 @@ module ReVIEW
 
       puts %Q(<div id="#{normalize_id(id)}" class="imgtable image">)
       begin
-        table_header id, caption if caption.present?
+        if caption.present?
+          table_header id, caption
+        end
       rescue KeyError
         error "no such table: #{id}"
       end
@@ -702,7 +712,7 @@ module ReVIEW
 
     def imgtable_image(id, caption, metric)
       metrics = parse_metric('html', metric)
-      puts %Q(<img src="#{@chapter.image(id).path.sub(%r{\A\./}, '')}" alt="#{escape_html(compile_inline(caption))}"#{metrics} />)
+      puts %Q(<img src="#{@chapter.image(id).path.sub(%r{\A\./}, '')}" alt="#{escape(compile_inline(caption))}"#{metrics} />)
     end
 
     def emtable(lines, caption = nil)
@@ -714,7 +724,7 @@ module ReVIEW
       lines.unshift comment unless comment.blank?
       return unless @book.config['draft']
       str = lines.join('<br />')
-      puts %Q(<div class="draft-comment">#{escape_html(str)}</div>)
+      puts %Q(<div class="draft-comment">#{escape(str)}</div>)
     end
 
     def footnote(id, str)
@@ -730,7 +740,7 @@ module ReVIEW
       caption = '' unless caption.present?
       puts %Q(<div id="#{normalize_id(id)}" class="image">)
       begin
-        puts %Q(<img src="#{@chapter.image(id).path.sub(%r{\A\./}, '')}" alt="#{escape_html(compile_inline(caption))}"#{metrics} />)
+        puts %Q(<img src="#{@chapter.image(id).path.sub(%r{\A\./}, '')}" alt="#{escape(compile_inline(caption))}"#{metrics} />)
       rescue
         warn "image not bound: #{id}"
         if lines
@@ -781,7 +791,7 @@ module ReVIEW
     end
 
     def inline_labelref(idref)
-      %Q(<a target='#{escape_html(idref)}'>「#{I18n.t('label_marker')}#{escape_html(idref)}」</a>)
+      %Q(<a target='#{escape(idref)}'>「#{I18n.t('label_marker')}#{escape(idref)}」</a>)
     end
 
     alias_method :inline_ref, :inline_labelref
@@ -834,50 +844,50 @@ module ReVIEW
 
     def compile_ruby(base, ruby)
       if @book.htmlversion == 5
-        %Q(<ruby>#{escape_html(base)}<rp>#{I18n.t('ruby_prefix')}</rp><rt>#{escape_html(ruby)}</rt><rp>#{I18n.t('ruby_postfix')}</rp></ruby>)
+        %Q(<ruby>#{escape(base)}<rp>#{I18n.t('ruby_prefix')}</rp><rt>#{escape(ruby)}</rt><rp>#{I18n.t('ruby_postfix')}</rp></ruby>)
       else
-        %Q(<ruby><rb>#{escape_html(base)}</rb><rp>#{I18n.t('ruby_prefix')}</rp><rt>#{ruby}</rt><rp>#{I18n.t('ruby_postfix')}</rp></ruby>)
+        %Q(<ruby><rb>#{escape(base)}</rb><rp>#{I18n.t('ruby_prefix')}</rp><rt>#{ruby}</rt><rp>#{I18n.t('ruby_postfix')}</rp></ruby>)
       end
     end
 
     def compile_kw(word, alt)
       %Q(<b class="kw">) +
         if alt
-        then escape_html(word + " (#{alt.strip})")
-        else escape_html(word)
+        then escape(word + " (#{alt.strip})")
+        else escape(word)
         end +
-        "</b><!-- IDX:#{escape_comment(escape_html(word))} -->"
+        "</b><!-- IDX:#{escape_comment(escape(word))} -->"
     end
 
     def inline_i(str)
-      %Q(<i>#{escape_html(str)}</i>)
+      %Q(<i>#{escape(str)}</i>)
     end
 
     def inline_b(str)
-      %Q(<b>#{escape_html(str)}</b>)
+      %Q(<b>#{escape(str)}</b>)
     end
 
     def inline_ami(str)
-      %Q(<span class="ami">#{escape_html(str)}</span>)
+      %Q(<span class="ami">#{escape(str)}</span>)
     end
 
     def inline_bou(str)
-      %Q(<span class="bou">#{escape_html(str)}</span>)
+      %Q(<span class="bou">#{escape(str)}</span>)
     end
 
     def inline_tti(str)
       if @book.htmlversion == 5
-        %Q(<code class="tt"><i>#{escape_html(str)}</i></code>)
+        %Q(<code class="tt"><i>#{escape(str)}</i></code>)
       else
-        %Q(<tt><i>#{escape_html(str)}</i></tt>)
+        %Q(<tt><i>#{escape(str)}</i></tt>)
       end
     end
 
     def inline_ttb(str)
       if @book.htmlversion == 5
-        %Q(<code class="tt"><b>#{escape_html(str)}</b></code>)
+        %Q(<code class="tt"><b>#{escape(str)}</b></code>)
       else
-        %Q(<tt><b>#{escape_html(str)}</b></tt>)
+        %Q(<tt><b>#{escape(str)}</b></tt>)
       end
     end
 
@@ -887,18 +897,18 @@ module ReVIEW
 
     def inline_code(str)
       if @book.htmlversion == 5
-        %Q(<code class="inline-code tt">#{escape_html(str)}</code>)
+        %Q(<code class="inline-code tt">#{escape(str)}</code>)
       else
-        %Q(<tt class="inline-code">#{escape_html(str)}</tt>)
+        %Q(<tt class="inline-code">#{escape(str)}</tt>)
       end
     end
 
     def inline_idx(str)
-      %Q(#{escape_html(str)}<!-- IDX:#{escape_comment(escape_html(str))} -->)
+      %Q(#{escape(str)}<!-- IDX:#{escape_comment(escape(str))} -->)
     end
 
     def inline_hidx(str)
-      %Q(<!-- IDX:#{escape_comment(escape_html(str))} -->)
+      %Q(<!-- IDX:#{escape_comment(escape(str))} -->)
     end
 
     def inline_br(_str)
@@ -920,7 +930,7 @@ module ReVIEW
         make_math_image(math_str, img_path)
         %Q(<span class="equation"><img src="#{img_path}" /></span>)
       else
-        %Q(<span class="equation">#{escape_html(str)}</span>)
+        %Q(<span class="equation">#{escape(str)}</span>)
       end
     end
 
@@ -1037,7 +1047,7 @@ module ReVIEW
     end
 
     def inline_asis(str, tag)
-      %Q(<#{tag}>#{escape_html(str)}</#{tag}>)
+      %Q(<#{tag}>#{escape(str)}</#{tag}>)
     end
 
     def inline_abbr(str)
@@ -1094,9 +1104,9 @@ module ReVIEW
 
     def inline_tt(str)
       if @book.htmlversion == 5
-        %Q(<code class="tt">#{escape_html(str)}</code>)
+        %Q(<code class="tt">#{escape(str)}</code>)
       else
-        %Q(<tt>#{escape_html(str)}</tt>)
+        %Q(<tt>#{escape(str)}</tt>)
       end
     end
 
@@ -1109,11 +1119,11 @@ module ReVIEW
     end
 
     def inline_u(str)
-      %Q(<u>#{escape_html(str)}</u>)
+      %Q(<u>#{escape(str)}</u>)
     end
 
     def inline_recipe(str)
-      %Q(<span class="recipe">「#{escape_html(str)}」</span>)
+      %Q(<span class="recipe">「#{escape(str)}」</span>)
     end
 
     def inline_icon(id)
@@ -1131,7 +1141,7 @@ module ReVIEW
 
     def inline_comment(str)
       if @book.config['draft']
-        %Q(<span class="draft-comment">#{escape_html(str)}</span>)
+        %Q(<span class="draft-comment">#{escape(str)}</span>)
       else
         ''
       end
@@ -1143,7 +1153,11 @@ module ReVIEW
       if str.size == 1 && str.match(/[[:ascii:]]/)
         style = 'upright'
       end
-      %Q(<span class="#{style}">#{escape_html(str)}</span>)
+      %Q(<span class="#{style}">#{escape(str)}</span>)
+    end
+
+    def inline_balloon(str)
+      %Q(<span class="balloon">#{escape_html(str)}</span>)
     end
 
     def inline_raw(str)
@@ -1151,14 +1165,14 @@ module ReVIEW
     end
 
     def nofunc_text(str)
-      escape_html(str)
+      escape(str)
     end
 
     def compile_href(url, label)
       if @book.config['externallink']
-        %Q(<a href="#{escape_html(url)}" class="link">#{label.nil? ? escape_html(url) : escape_html(label)}</a>)
+        %Q(<a href="#{escape(url)}" class="link">#{label.nil? ? escape(url) : escape(label)}</a>)
       else
-        label.nil? ? escape_html(url) : I18n.t('external_link', [escape_html(label), escape_html(url)])
+        label.nil? ? escape(url) : I18n.t('external_link', [escape(label), escape(url)])
       end
     end
 
@@ -1199,7 +1213,11 @@ module ReVIEW
         tex_path = File.join(tmpdir, 'tmpmath.tex')
         dvi_path = File.join(tmpdir, 'tmpmath.dvi')
         File.write(tex_path, texsrc)
-        system("latex --interaction=nonstopmode --output-directory=#{tmpdir} #{tex_path} && dvipng -T tight -z9 -o #{path} #{dvi_path}")
+        cmd = "latex --interaction=nonstopmode --output-directory=#{tmpdir} #{tex_path} && dvipng -T tight -z9 -o #{path} #{dvi_path}"
+        out, status = Open3.capture2e(cmd)
+        unless status.success?
+          error "latex compile error\n\nError log:\n" + out
+        end
       end
     end
   end

data/lib/review/htmlutils.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2006-2017 Minero Aoki, Kenshi Muto
+# Copyright (c) 2006-2018 Minero Aoki, Kenshi Muto
 #               2002-2006 Minero Aoki
 #
 # This program is free software.
@@ -17,20 +17,20 @@ module ReVIEW
       '"' => '"'
     } # .freeze
 
-    def escape_html(str)
+    def escape(str)
       t = ESC
       str.gsub(/[&"<>]/) { |c| t[c] }
     end
 
-    alias_method :escape, :escape_html
-    alias_method :h, :escape_html
+    alias_method :escape_html, :escape # for backward compatibility
+    alias_method :h, :escape
 
-    def unescape_html(str)
+    def unescape(str)
       # FIXME: better code
       str.gsub('&quot;', '"').gsub('&gt;', '>').gsub('&lt;', '<').gsub('&amp;', '&')
     end
 
-    alias_method :unescape, :unescape_html
+    alias_method :unescape_html, :unescape # for backward compatibility
 
     def strip_html(str)
       str.gsub(%r{</?[^>]*>}, '')
@@ -62,13 +62,14 @@ module ReVIEW
 
     def highlight_pygments(ops)
       body = ops[:body] || ''
-      if @book.config['highlight'] && @book.config['highlight']['lang']
+      format = ops[:format] || ''
+      if ops[:lexer].present?
+        lexer = ops[:lexer]
+      elsif @book.config['highlight'] && @book.config['highlight']['lang']
         lexer = @book.config['highlight']['lang'] # default setting
       else
         lexer = 'text'
       end
-      lexer = ops[:lexer] if ops[:lexer].present?
-      format = ops[:format] || ''
       options = { nowrap: true, noclasses: true }
       if ops[:linenum]
         options[:nowrap] = false
@@ -81,7 +82,7 @@ module ReVIEW
       begin
         require 'pygments'
         begin
-          Pygments.highlight(unescape_html(body),
+          Pygments.highlight(unescape(body),
                              options: options,
                              formatter: format,
                              lexer: lexer)
@@ -111,7 +112,10 @@ module ReVIEW
 
       require 'rouge'
       lexer = Rouge::Lexer.find(lexer)
-      raise "unknown lexer #{lexer}" unless lexer
+
+      unless lexer
+        return body
+      end
 
       formatter = Rouge::Formatters::HTML.new(css_class: 'highlight')
       if ops[:linenum]
@@ -119,9 +123,12 @@ module ReVIEW
                                                      table_class: 'highlight rouge-table',
                                                      start_line: first_line_num)
       end
-      raise "unknown formatter #{formatter}" unless formatter
 
-      text = unescape_html(body)
+      unless formatter
+        return body
+      end
+
+      text = unescape(body)
       formatter.format(lexer.lex(text))
     end
 

data/lib/review/i18n.rb

@@ -21,10 +21,14 @@ module ReVIEW
         lfile = File.expand_path(ymlfile, Dir.pwd)
 
         # backward compatibility
-        raise ReVIEW::ConfigError, 'locale.yaml is obsoleted. Please use locale.yml.' if !File.exist?(lfile) && (ymlfile == 'locale.yml') && File.exist?(File.expand_path('locale.yaml', Dir.pwd))
+        if !File.exist?(lfile) && (ymlfile == 'locale.yml') && File.exist?(File.expand_path('locale.yaml', Dir.pwd))
+          raise ReVIEW::ConfigError, 'locale.yaml is obsoleted. Please use locale.yml.'
+        end
       end
 
-      @i18n.update_localefile(lfile) if lfile && File.file?(lfile)
+      if lfile && File.file?(lfile)
+        @i18n.update_localefile(lfile)
+      end
     end
 
     def self.i18n(*_args)