review 2.5.0 → 3.0.0.preview1

data/lib/review/latexbuilder.rb

@@ -52,7 +52,11 @@ module ReVIEW
       end
       return true unless @book.config['pdfmaker']['makeindex_mecab']
       begin
-        require 'MeCab'
+        begin
+          require 'MeCab'
+        rescue LoadError
+          require 'mecab'
+        end
         require 'nkf'
         @index_mecab = MeCab::Tagger.new(@book.config['pdfmaker']['makeindex_mecab_opts'])
       rescue LoadError
@@ -150,8 +154,11 @@ module ReVIEW
     end
 
     def nodisp_begin(level, _label, caption)
-      blank unless @output.pos == 0
-      puts macro('clearpage') if @output.pos == 0
+      if @output.pos != 0
+        blank
+      else
+        puts macro('clearpage')
+      end
       puts macro('addcontentsline', 'toc', HEADLINE[level], compile_inline(caption))
       # FIXME: headings
     end
@@ -162,36 +169,62 @@ module ReVIEW
     def column_begin(level, label, caption)
       blank
       @doc_status[:column] = true
-      puts "\\begin{reviewcolumn}\n"
+
+      target = nil
       if label
-        puts "\\hypertarget{#{column_label(label)}}{}"
+        target = "\\hypertarget{#{column_label(label)}}{}"
       else
-        puts "\\hypertarget{#{column_label(caption)}}{}"
+        target = "\\hypertarget{#{column_label(caption)}}{}"
       end
+
       @doc_status[:caption] = true
-      puts macro('reviewcolumnhead', nil, compile_inline(caption))
+      if @book.config.check_version('2', exception: false)
+        puts '\\begin{reviewcolumn}'
+        puts target
+        puts macro('reviewcolumnhead', nil, compile_inline(caption))
+      else
+        # ver.3
+        print '\\begin{reviewcolumn}'
+        puts "[#{compile_inline(caption)}#{target}]"
+      end
       @doc_status[:caption] = nil
+
       if level <= @book.config['toclevel'].to_i
         puts "\\addcontentsline{toc}{#{HEADLINE[level]}}{#{compile_inline(caption)}}"
       end
     end
 
     def column_end(_level)
-      puts "\\end{reviewcolumn}\n"
+      puts '\\end{reviewcolumn}'
       blank
       @doc_status[:column] = nil
     end
 
-    def captionblock(_type, lines, caption)
-      puts "\\begin{reviewminicolumn}\n"
+    def captionblock(type, lines, caption)
+      if @book.config.check_version('2', exception: false)
+        type = 'minicolumn'
+      end
+
+      print "\\begin{review#{type}}"
+
       @doc_status[:caption] = true
-      puts "\\reviewminicolumntitle{#{compile_inline(caption)}}\n" if caption.present?
+      if @book.config.check_version('2', exception: false)
+        puts
+        if caption.present?
+          puts "\\reviewminicolumntitle{#{compile_inline(caption)}}"
+        end
+      else
+        if caption.present?
+          print "[#{compile_inline(caption)}]"
+        end
+        puts
+      end
 
       @doc_status[:caption] = nil
       blocked_lines = split_paragraph(lines)
       puts blocked_lines.join("\n\n")
 
-      puts "\\end{reviewminicolumn}\n"
+      puts "\\end{review#{type}}"
     end
 
     def box(lines, caption = nil)
@@ -332,6 +365,9 @@ module ReVIEW
 
     def common_code_block(id, lines, command, caption, _lang)
       @doc_status[:caption] = true
+      unless @book.config.check_version('2', exception: false)
+        puts '\\begin{reviewlistblock}'
+      end
       if caption.present?
         if command =~ /emlist/ || command =~ /cmd/ || command =~ /source/
           puts macro(command + 'caption', compile_inline(caption))
@@ -355,14 +391,17 @@ module ReVIEW
       puts macro('begin', command)
       print body
       puts macro('end', command)
+      unless @book.config.check_version('2', exception: false)
+        puts '\\end{reviewlistblock}'
+      end
       blank
     end
 
     def common_code_block_lst(_id, lines, command, title, caption, lang, first_line_num: 1)
-      if title == 'title' && caption.blank?
+      if title == 'title' && caption.blank? && @book.config.check_version('2', exception: false)
         print '\vspace{-1.5em}'
       end
-      body = lines.inject('') { |i, j| i + detab(unescape_latex(j)) + "\n" }
+      body = lines.inject('') { |i, j| i + detab(unescape(j)) + "\n" }
       args = make_code_block_args(title, caption, lang, first_line_num: first_line_num)
       puts %Q(\\begin{#{command}}[#{args}])
       print body
@@ -372,7 +411,7 @@ module ReVIEW
 
     def make_code_block_args(title, caption, lang, first_line_num: 1)
       caption_str = compile_inline((caption || ''))
-      if title == 'title' && caption_str == ''
+      if title == 'title' && caption_str == '' && @book.config.check_version('2', exception: false)
         caption_str = '\relax' ## dummy charactor to remove lstname
       end
       lexer = if @book.config['highlight'] && @book.config['highlight']['lang']
@@ -381,9 +420,14 @@ module ReVIEW
                 ''
               end
       lexer = lang if lang.present?
-      args = %Q(#{title}={#{caption_str}},language={#{lexer}})
+      args = "language={#{lexer}}"
+      if title == 'title' && caption_str == ''
+        # ignore
+      else
+        args = "#{title}={#{caption_str}}," + args
+      end
       if first_line_num != 1
-        args += ",firstnumber=#{first_line_num}"
+        args << ",firstnumber=#{first_line_num}"
       end
       args
     end
@@ -500,7 +544,10 @@ module ReVIEW
       end
 
       @doc_status[:caption] = true
-      puts macro('reviewindepimagecaption', %Q(#{I18n.t('numberless_image')}#{I18n.t('caption_prefix')}#{compile_inline(caption)})) if caption.present?
+      if caption.present?
+        puts macro('reviewindepimagecaption',
+                   %Q(#{I18n.t('numberless_image')}#{I18n.t('caption_prefix')}#{compile_inline(caption)}))
+      end
       @doc_status[:caption] = nil
 
       if @chapter.image(id).path
@@ -527,12 +574,12 @@ module ReVIEW
       rows = adjust_n_cols(rows)
 
       begin
-        table_header id, caption if caption.present?
+        table_header(id, caption) if caption.present?
       rescue KeyError
         error "no such table: #{id}"
       end
       return if rows.empty?
-      table_begin rows.first.size
+      table_begin(rows.first.size)
       if sepidx
         sepidx.times do
           tr(rows.shift.map { |s| th(s) })
@@ -682,7 +729,7 @@ module ReVIEW
       blank
       puts macro('begin', 'equation*')
       lines.each do |line|
-        puts unescape_latex(line)
+        puts unescape(line)
       end
       puts macro('end', 'equation*')
       blank
@@ -834,12 +881,16 @@ module ReVIEW
     end
 
     def compile_ruby(base, ruby)
-      macro('ruby', escape(base), escape(ruby))
+      macro('ruby', escape(base), escape(ruby).gsub('\\textbar{}', '|'))
     end
 
     # math
     def inline_m(str)
-      " $#{str}$ "
+      if @book.config.check_version('2', exception: false)
+        " $#{str}$ "
+      else
+        "$#{str}$"
+      end
     end
 
     # hidden index
@@ -849,7 +900,11 @@ module ReVIEW
 
     # index -> italic
     def inline_i(str)
-      macro('textit', escape(str))
+      if @book.config.check_version('2', exception: false)
+        macro('textit', escape(str))
+      else
+        macro('reviewit', escape(str))
+      end
     end
 
     # index
@@ -864,7 +919,11 @@ module ReVIEW
 
     # bold
     def inline_b(str)
-      macro('textbf', escape(str))
+      if @book.config.check_version('2', exception: false)
+        macro('textbf', escape(str))
+      else
+        macro('reviewbold', escape(str))
+      end
     end
 
     # line break
@@ -879,7 +938,11 @@ module ReVIEW
 
     ## @<code> is same as @<tt>
     def inline_code(str)
-      macro('texttt', escape(str))
+      if @book.config.check_version('2', exception: false)
+        macro('texttt', escape(str))
+      else
+        macro('reviewcode', escape(str))
+      end
     end
 
     def nofunc_text(str)
@@ -887,7 +950,11 @@ module ReVIEW
     end
 
     def inline_tt(str)
-      macro('texttt', escape(str))
+      if @book.config.check_version('2', exception: false)
+        macro('texttt', escape(str))
+      else
+        macro('reviewtt', escape(str))
+      end
     end
 
     def inline_del(str)
@@ -895,11 +962,19 @@ module ReVIEW
     end
 
     def inline_tti(str)
-      macro('texttt', macro('textit', escape(str)))
+      if @book.config.check_version('2', exception: false)
+        macro('texttt', macro('textit', escape(str)))
+      else
+        macro('reviewtti', escape(str))
+      end
     end
 
     def inline_ttb(str)
-      macro('texttt', macro('textbf', escape(str)))
+      if @book.config.check_version('2', exception: false)
+        macro('texttt', macro('textbf', escape(str)))
+      else
+        macro('reviewttb', escape(str))
+      end
     end
 
     def inline_bib(id)
@@ -967,8 +1042,13 @@ module ReVIEW
     end
 
     def inline_uchar(str)
-      # with otf package
-      macro('UTF', escape(str))
+      if @texcompiler && @texcompiler.start_with?('platex')
+        # with otf package
+        macro('UTF', escape(str))
+      else
+        # passthrough
+        [str.to_i(16)].pack('U')
+      end
     end
 
     def inline_comment(str)
@@ -983,6 +1063,10 @@ module ReVIEW
       macro('rensuji', escape(str))
     end
 
+    def inline_balloon(str)
+      macro('reviewballoon', escape(str))
+    end
+
     def bibpaper_header(id, caption)
       puts "[#{@chapter.bibpaper(id).number}] #{compile_inline(caption)}"
       puts macro('label', bib_label(id))
@@ -998,10 +1082,10 @@ module ReVIEW
 
       sa.map! do |item|
         if @index_db[item]
-          escape_index(escape_latex(@index_db[item])) + '@' + escape_index(escape_latex(item))
+          escape_index(escape(@index_db[item])) + '@' + escape_index(escape(item))
         else
           if item =~ /\A[[:ascii:]]+\Z/ || @index_mecab.nil?
-            esc_item = escape_index(escape_latex(item))
+            esc_item = escape_index(escape(item))
             if esc_item != item
               "#{escape_index(item)}@#{esc_item}"
             else
@@ -1009,7 +1093,7 @@ module ReVIEW
             end
           else
             yomi = NKF.nkf('-w --hiragana', @index_mecab.parse(item).force_encoding('UTF-8').chomp)
-            escape_index(escape_latex(yomi)) + '@' + escape_index(escape_latex(item))
+            escape_index(escape(yomi)) + '@' + escape_index(escape(item))
           end
         end
       end

data/lib/review/latexutils.rb

@@ -1,5 +1,5 @@
 # Copyright (c) 2002-2006 Minero Aoki
-# Copyright (c) 2006-2017 Minero Aoki, Kenshi Muto and Masayoshi Takahashi
+# Copyright (c) 2006-2018 Minero Aoki, Kenshi Muto and Masayoshi Takahashi
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -64,18 +64,18 @@ module ReVIEW
       @metachars_invert = @metachars.invert
     end
 
-    def escape_latex(str)
+    def escape(str)
       str.gsub(@metachars_re) { |s| @metachars[s] or raise "unknown trans char: #{s}" }
     end
 
-    alias_method :escape, :escape_latex
+    alias_method :escape_latex, :escape # backward compatibility
 
-    def unescape_latex(str)
+    def unescape(str)
       metachars_invert_re = Regexp.new(@metachars_invert.keys.collect { |key| Regexp.escape(key) }.join('|'))
       str.gsub(metachars_invert_re) { |s| @metachars_invert[s] or raise "unknown trans char: #{s}" }
     end
 
-    alias_method :unescape, :unescape_latex
+    alias_method :unescape_latex, :unescape # backward compatibility
 
     def escape_index(str)
       str.gsub(/[@!|"]/) { |s| '"' + s }

data/lib/review/logger.rb

@@ -4,7 +4,8 @@ module ReVIEW
   class Logger < ::Logger
     def initialize(*logdev)
       if logdev.empty?
-        super(STDERR, formatter: ->(severity, _datetime, _progname, msg) { "#{severity}: #{msg}\n" })
+        super(STDERR)
+        self.formatter = ->(severity, _datetime, _progname, msg) { "#{severity}: #{msg}\n" }
       else
         super
       end

data/lib/review/makerhelper.rb

@@ -51,7 +51,7 @@ module ReVIEW
               image_files << "#{from_dir}/#{fname}.#{conv_type}"
             end
 
-            exts = options[:exts] || %w[png gif jpg jpeg svg pdf eps ai tif]
+            exts = options[:exts] || %w[png gif jpg jpeg svg pdf eps ai tif psd]
             exts_str = exts.join('|')
             if !is_converted && fname =~ /\.(#{exts_str})$/i
               FileUtils.cp "#{from_dir}/#{fname}", to_dir

data/lib/review/markdownbuilder.rb

@@ -16,6 +16,7 @@ module ReVIEW
     end
 
     def builder_init_file
+      @noindent = nil
       @blank_seen = nil
       @ul_indent = 0
       @chapter.book.image_types = %w[.png .jpg .jpeg .gif .svg]
@@ -48,8 +49,18 @@ module ReVIEW
     end
 
     def paragraph(lines)
-      puts lines.join
-      puts "\n"
+      if @noindent
+        puts %Q(<p class="noindent">#{lines.join}</p>)
+        puts "\n"
+        @noindent = nil
+      else
+        puts lines.join
+        puts "\n"
+      end
+    end
+
+    def noindent
+      @noindent = true
     end
 
     def list_header(id, caption, lang)
@@ -129,6 +140,14 @@ module ReVIEW
       blank
     end
 
+    def captionblock(type, lines, caption, _specialstyle = nil)
+      puts %Q(<div class="#{type}">)
+      puts %Q(<p class="caption">#{compile_inline(caption)}</p>) if caption.present?
+      blocked_lines = split_paragraph(lines)
+      puts blocked_lines.join("\n")
+      puts '</div>'
+    end
+
     def hr
       puts '----'
     end
@@ -160,10 +179,22 @@ module ReVIEW
       "`#{str}`"
     end
 
+    def inline_sub(str)
+      "<sub>#{str}</sub>"
+    end
+
+    def inline_sup(str)
+      "<sup>#{str}</sup>"
+    end
+
     def inline_tt(str)
       "`#{str}`"
     end
 
+    def inline_u(str)
+      "<u>#{str}</u>"
+    end
+
     def image_image(id, caption, _metric)
       blank
       puts "![#{compile_inline(caption)}](#{@chapter.image(id).path.sub(%r{\A\./}, '')})"
@@ -180,6 +211,10 @@ module ReVIEW
       error "unknown image: #{id}"
     end
 
+    def inline_dtp(str)
+      "<!-- DTP:#{str} -->"
+    end
+
     def indepimage(_lines, id, caption = '', _metric = nil)
       blank
       puts "![#{compile_inline(caption)}](#{@chapter.image(id).path.sub(%r{\A\./}, '')})"
@@ -293,12 +328,22 @@ 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
+          escape_html(word + " (#{alt.strip})")
+        else
+          escape_html(word)
+        end +
+        "</b><!-- IDX:#{escape_comment(escape_html(word))} -->"
+    end
+
     def comment(lines, comment = nil)
       return unless @book.config['draft']
       lines ||= []
@@ -306,15 +351,30 @@ module ReVIEW
         lines.unshift comment
       end
       str = lines.join('<br />')
-      puts %Q(<div class="red">#{escape_html(str)}</div>)
+      puts %Q(<div class="red">#{escape(str)}</div>)
+    end
+
+    def inline_icon(id)
+      begin
+        "![](#{@chapter.image(id).path.sub(%r{\A\./}, '')})"
+      rescue
+        warn "image not bound: #{id}"
+        %Q(<pre>missing image: #{id}</pre>)
+      end
     end
 
     def inline_comment(str)
       if @book.config['draft']
-        %Q(<span class="red">#{escape_html(str)}</span>)
+        %Q(<span class="red">#{escape(str)}</span>)
       else
         ''
       end
     end
+
+    def flushright(lines)
+      puts %Q(<div class="flushright">)
+      puts lines.join
+      puts %Q(</div>)
+    end
   end
 end # module ReVIEW

data/lib/review/md2inaobuilder.rb

@@ -44,9 +44,9 @@ module ReVIEW
 
     def compile_ruby(base, ruby)
       if base.length == 1
-        %Q[<span class='monoruby'>#{escape_html(base)}(#{escape_html(ruby)})</span>]
+        %Q[<span class='monoruby'>#{escape(base)}(#{escape(ruby)})</span>]
       else
-        %Q[<span class='groupruby'>#{escape_html(base)}(#{escape_html(ruby)})</span>]
+        %Q[<span class='groupruby'>#{escape(base)}(#{escape(ruby)})</span>]
       end
     end
   end