review 2.1.0 → 2.2.0

data/lib/review/ewbbuilder.rb

@@ -27,11 +27,11 @@ module ReVIEW
       puts
     end
 
-#     Compiler.defsyntax(:emlist, :block, 0..1) {|args|
-#       if args[0] and not args[0] == 'noescape'
-#         raise SyntaxError, "unknown //emlist option: #{args[0]}"
-#       end
-#     }
+    # Compiler.defsyntax(:emlist, :block, 0..1) {|args|
+    #   if args[0] and not args[0] == 'noescape'
+    #     raise SyntaxError, "unknown //emlist option: #{args[0]}"
+    #   end
+    # }
 
     def emlist(lines, caption = nil)
       # firstline = f.lineno
@@ -49,11 +49,11 @@ module ReVIEW
       puts
     end
 
-#     Compiler.defsyntax(:cmd, :block, 0..1) {|args|
-#       if args[0] and not args[0] == 'noescape'
-#         raise SyntaxError, "unknown //cmd option: #{args[0]}"
-#       end
-#     }
+    # Compiler.defsyntax(:cmd, :block, 0..1) {|args|
+    #   if args[0] and not args[0] == 'noescape'
+    #     raise SyntaxError, "unknown //cmd option: #{args[0]}"
+    #   end
+    # }
 
     def cmd(lines, caption = nil)
       puts
@@ -73,11 +73,11 @@ module ReVIEW
       puts
     end
 
-#     Compiler.defsyntax(:list, :block, 0..1) {|args|
-#       if args[0] and not args[0] == 'noescape'
-#         raise SyntaxError, "unknown //list option: #{args[0]}"
-#       end
-#     }
+    # Compiler.defsyntax(:list, :block, 0..1) {|args|
+    #   if args[0] and not args[0] == 'noescape'
+    #     raise SyntaxError, "unknown //list option: #{args[0]}"
+    #   end
+    # }
 
     def list(lines, id, caption)
       puts
@@ -91,7 +91,7 @@ module ReVIEW
     end
 
     def image_header(file, caption)
-      if /\.png\z/ =~ file and not FileTest.exist?('images/' + file)
+      if /\.png\z/ =~ file and !FileTest.exist?('images/' + file)
         warn "image file not exist: #{file}"
       end
       id = file.sub(/\.\w+\z/, '')

data/lib/review/htmlbuilder.rb

@@ -32,6 +32,7 @@ module ReVIEW
     def pre_paragraph
       '<p>'
     end
+
     def post_paragraph
       '</p>'
     end
@@ -44,6 +45,8 @@ module ReVIEW
       @no_error = no_error
       @noindent = nil
       @ol_num = nil
+      @error_messages = nil
+      @warning_messages = nil
     end
     private :builder_init
 
@@ -54,12 +57,13 @@ module ReVIEW
       @column = 0
       @sec_counter = SecCounter.new(5, @chapter)
       @nonum_counter = 0
+      @first_line_num = nil
       @body_ext = nil
       @toc = nil
     end
     private :builder_init_file
 
-    def result
+    def layoutfile
       if @book.config.maker == "webmaker"
         htmldir = "web/html"
         localfilename = "layout-web.html.erb"
@@ -85,10 +89,11 @@ module ReVIEW
       else
         layout_file = File.expand_path(htmlfilename, ReVIEW::Template::TEMPLATE_DIR)
       end
+      layout_file
+    end
 
+    def result
       # default XHTML header/footer
-      @error_messages = error_messages
-      @warning_messages = warning_messages
       @title = strip_html(compile_inline(@chapter.title))
       @body = @output.string
       @language = @book.config['language']
@@ -102,7 +107,7 @@ module ReVIEW
         @toc = ReVIEW::WEBTOCPrinter.book_to_string(@book)
       end
 
-      tmpl = ReVIEW::Template.load(layout_file)
+      tmpl = ReVIEW::Template.load(layoutfile)
       tmpl.result(binding)
     end
 
@@ -132,30 +137,6 @@ module ReVIEW
       end
     end
 
-    def messages
-      error_messages() + warning_messages()
-    end
-
-    def error_messages
-      return '' if @errors.empty?
-      "<h2>Syntax Errors</h2>\n" +
-      "<ul>\n" +
-        @errors.map {|file, line, msg|
-        "<li>#{escape_html(file)}:#{line}: #{escape_html(msg.to_s)}</li>\n"
-        }.join('') +
-      "</ul>\n"
-    end
-
-    def warning_messages
-      return '' if @warns.empty?
-      "<h2>Warnings</h2>\n" +
-      "<ul>\n" +
-      @warns.map {|file, line, msg|
-        "<li>#{escape_html(file)}:#{line}: #{escape_html(msg)}</li>\n"
-      }.join('') +
-      "</ul>\n"
-    end
-
     def headline(level, label, caption)
       prefix, anchor = headline_prefix(level)
       unless prefix.nil?
@@ -241,7 +222,7 @@ module ReVIEW
           puts %Q[<h#{level} id="#{normalize_id(label)}">#{a_id}#{compile_inline(caption)}</h#{level}>]
         end
       end
-#      headline(level, label, caption)
+      # headline(level, label, caption)
     end
 
     def column_end(level)
@@ -275,10 +256,6 @@ module ReVIEW
       puts '</div>'
     end
 
-    def tsize(str)
-      # null
-    end
-
     def captionblock(type, lines, caption)
       puts %Q[<div class="#{type}">]
       unless caption.nil?
@@ -354,10 +331,6 @@ module ReVIEW
       puts '<ul>'
     end
 
-    def ul_item(lines)
-      puts "<li>#{lines.join}</li>"
-    end
-
     def ul_item_begin(lines)
       print "<li>#{lines.join}"
     end
@@ -424,7 +397,7 @@ module ReVIEW
     alias_method :lead, :read
 
     def list(lines, id, caption, lang = nil)
-      puts %Q[<div class="caption-code">]
+      puts %Q[<div id="#{normalize_id(id)}" class="caption-code">]
       begin
         list_header id, caption, lang
       rescue KeyError
@@ -447,6 +420,7 @@ module ReVIEW
       class_names = ["list"]
       lexer = lang || File.extname(id).gsub(/\./, '')
       class_names.push("language-#{lexer}") unless lexer.blank?
+      class_names.push("highlight") if highlight?
       print %Q[<pre class="#{class_names.join(" ")}">]
       body = lines.inject(''){|i, j| i + detab(j) + "\n"}
       puts highlight(:body => body, :lexer => lexer, :format => 'html')
@@ -476,7 +450,7 @@ module ReVIEW
     end
 
     def listnum(lines, id, caption, lang = nil)
-      puts %Q[<div class="code">]
+      puts %Q[<div id="#{normalize_id(id)}" class="code">]
       begin
         list_header id, caption, lang
       rescue KeyError
@@ -490,14 +464,17 @@ module ReVIEW
       if highlight?
         body = lines.inject(''){|i, j| i + detab(j) + "\n"}
         lexer = lang
-        puts highlight(:body => body, :lexer => lexer, :format => 'html',
-                       :options => {:linenos => 'inline', :nowrap => false})
+        first_line_number = get_line_num
+        puts highlight(:body => body, :lexer => lexer, :format => 'html', :linenum => true,
+                       :options => {:linenostart => first_line_number})
       else
         class_names = ["list"]
         class_names.push("language-#{lang}") unless lang.blank?
+        class_names.push("highlight") if highlight?
         print %Q[<pre class="#{class_names.join(" ")}">]
+        first_line_num = get_line_num
         lines.each_with_index do |line, i|
-          puts detab((i+1).to_s.rjust(2) + ": " + line)
+          puts detab((i+first_line_num).to_s.rjust(2) + ": " + line)
         end
         puts '</pre>'
       end
@@ -510,6 +487,7 @@ module ReVIEW
       end
       class_names = ["emlist"]
       class_names.push("language-#{lang}") unless lang.blank?
+      class_names.push("highlight") if highlight?
       print %Q[<pre class="#{class_names.join(" ")}">]
       body = lines.inject(''){|i, j| i + detab(j) + "\n"}
       lexer = lang
@@ -527,14 +505,17 @@ module ReVIEW
       if highlight?
         body = lines.inject(''){|i, j| i + detab(j) + "\n"}
         lexer = lang
-        puts highlight(:body => body, :lexer => lexer, :format => 'html',
-                       :options => {:linenos => 'inline', :nowrap => false})
+        first_line_number = get_line_num
+        puts highlight(:body => body, :lexer => lexer, :format => 'html', :linenum => true,
+                       :options => {:linenostart => first_line_number})
       else
         class_names = ["emlist"]
         class_names.push("language-#{lang}") unless lang.blank?
+        class_names.push("highlight") if highlight?
         print %Q[<pre class="#{class_names.join(" ")}">]
+        first_line_num = get_line_num
         lines.each_with_index do |line, i|
-          puts detab((i+1).to_s.rjust(2) + ": " + line)
+          puts detab((i+first_line_num).to_s.rjust(2) + ": " + line)
         end
         puts '</pre>'
       end
@@ -751,10 +732,7 @@ module ReVIEW
       lines.unshift comment unless comment.blank?
       if @book.config["draft"]
         str = lines.join("<br />")
-        puts %Q(<div class="draft-comment">#{str}</div>)
-      else
-        str = lines.join("\n")
-        puts %Q(<!-- #{escape_comment(str)} -->)
+        puts %Q(<div class="draft-comment">#{escape_html(str)}</div>)
       end
     end
 
@@ -998,18 +976,24 @@ module ReVIEW
 
     def inline_column_chap(chapter, id)
       if @book.config["chapterlink"]
-        %Q(<a href="\##{column_label(id)}" class="columnref">#{I18n.t("column", escape_html(chapter.column(id).caption))}</a>)
+        %Q(<a href="\##{column_label(id)}" class="columnref">#{I18n.t("column", compile_inline(chapter.column(id).caption))}</a>)
       else
-        I18n.t("column", escape_html(chapter.column(id).caption))
+        I18n.t("column", compile_inline(chapter.column(id).caption))
       end
     end
 
     def inline_list(id)
       chapter, id = extract_chapter_id(id)
+      str = nil
       if get_chap(chapter).nil?
-        "#{I18n.t("list")}#{I18n.t("format_number_without_header", [chapter.list(id).number])}"
+        str = "#{I18n.t("list")}#{I18n.t("format_number_without_header", [chapter.list(id).number])}"
       else
-        "#{I18n.t("list")}#{I18n.t("format_number", [get_chap(chapter), chapter.list(id).number])}"
+        str = "#{I18n.t("list")}#{I18n.t("format_number", [get_chap(chapter), chapter.list(id).number])}"
+      end
+      if @book.config["chapterlink"]
+        %Q(<span class="listref"><a href="./#{chapter.id}#{extname}##{id}">#{str}</a></span>)
+      else
+        %Q(<span class="listref">#{str}</span>)
       end
     rescue KeyError
       error "unknown list: #{id}"
@@ -1025,9 +1009,9 @@ module ReVIEW
         str = "#{I18n.t("table")}#{I18n.t("format_number", [get_chap(chapter), chapter.table(id).number])}"
       end
       if @book.config["chapterlink"]
-        %Q(<a href="./#{chapter.id}#{extname}##{id}">#{str}</a>)
+        %Q(<span class="tableref"><a href="./#{chapter.id}#{extname}##{id}">#{str}</a></span>)
       else
-        str
+        %Q(<span class="tableref">#{str}</span>)
       end
     rescue KeyError
       error "unknown table: #{id}"
@@ -1043,9 +1027,9 @@ module ReVIEW
         str = "#{I18n.t("image")}#{I18n.t("format_number", [get_chap(chapter), chapter.image(id).number])}"
       end
       if @book.config["chapterlink"]
-        %Q(<a href="./#{chapter.id}#{extname}##{normalize_id(id)}">#{str}</a>)
+        %Q(<span class="imgref"><a href="./#{chapter.id}#{extname}##{normalize_id(id)}">#{str}</a></span>)
       else
-        str
+        %Q(<span class="imgref">#{str}</span>)
       end
     rescue KeyError
       error "unknown image: #{id}"
@@ -1148,7 +1132,7 @@ module ReVIEW
       if @book.config["draft"]
         %Q(<span class="draft-comment">#{escape_html(str)}</span>)
       else
-        %Q(<!-- #{escape_comment(escape_html(str))} -->)
+        ""
       end
     end
 

data/lib/review/htmltoc.rb

@@ -28,7 +28,7 @@ module ReVIEW
     end
 
     def decode_args(args_str)
-      args = Hash.new
+      args = {}
       args_str.split(/,\s*/).each do |pair|
         key, val = pair.split("=")
         args[key.to_sym] = val

data/lib/review/htmlutils.rb

@@ -28,7 +28,7 @@ module ReVIEW
     alias_method :h, :escape_html
 
     def unescape_html(str)
-      # FIXME better code
+      # FIXME: better code
       str.gsub('&quot;', '"').gsub('&gt;', '>').gsub('&lt;', '<').gsub('&amp;', '&')
     end
 
@@ -44,14 +44,25 @@ module ReVIEW
 
     def highlight?
       @book.config["highlight"] &&
-        @book.config["highlight"]["html"] == "pygments"
+        @book.config["highlight"]["html"]
     end
 
     def highlight(ops)
       if @book.config["pygments"].present?
         raise ReVIEW::ConfigError, "'pygments:' in config.yml is obsoleted."
       end
+      return ops[:body].to_s if !highlight?
 
+      if @book.config["highlight"]["html"] == "pygments"
+        highlight_pygments(ops)
+      elsif @book.config["highlight"]["html"] == "rouge"
+        highlight_rouge(ops)
+      else
+        raise ReVIEW::ConfigError, "unknown highlight method #{@book.config["highlight"]["html"]} in config.yml."
+      end
+    end
+
+    def highlight_pygments(ops)
       body = ops[:body] || ''
       if @book.config["highlight"] && @book.config["highlight"]["lang"]
         lexer = @book.config["highlight"]["lang"] # default setting
@@ -61,10 +72,13 @@ module ReVIEW
       lexer = ops[:lexer] if ops[:lexer].present?
       format = ops[:format] || ''
       options = {:nowrap => true, :noclasses => true}
+      if ops[:linenum]
+        options[:nowrap] = false
+        options[:linenos] = 'inline'
+      end
       if ops[:options] && ops[:options].kind_of?(Hash)
         options.merge!(ops[:options])
       end
-      return body if !highlight?
 
       begin
         require 'pygments'
@@ -77,8 +91,40 @@ module ReVIEW
           body
         end
       rescue LoadError
-          body
+        body
+      end
+    end
+
+    def highlight_rouge(ops)
+      body = ops[:body] || ''
+      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
+      format = ops[:format] || ''
+
+      first_line_num = 1 ## default
+      if ops[:options] && ops[:options][:linenostart]
+        first_line_num = ops[:options][:linenostart]
       end
+
+      require 'rouge'
+      lexer = Rouge::Lexer.find(lexer)
+      raise "unknown lexer #{lexer}" unless lexer
+
+      formatter = Rouge::Formatters::HTML.new(:css_class => 'highlight')
+      if ops[:linenum]
+        formatter = Rouge::Formatters::HTMLTable.new(formatter,
+                                                     :table_class => 'highlight rouge-table',
+                                                     :start_line => first_line_num)
+      end
+      raise "unknown formatter #{formatter}" unless formatter
+
+      text = unescape_html(body)
+      formatter.format(lexer.lex(text))
     end
 
     def normalize_id(id)

data/lib/review/i18n.rb

@@ -154,13 +154,13 @@ module ReVIEW
           frmt.sub!(i, ARABIC_UW[args[idx]])
           remove_args << idx
         else
-          # noop
+          # do nothing
         end
       end
       remove_args.reverse_each do |idx|
         args.delete_at idx
       end
-      args_matched = (frmt.count("%") == args.size)
+      args_matched = (frmt.count("%") <= args.size)
       frmt.gsub!('##', '%%')
       args_matched ? (frmt % args) : frmt
     rescue

data/lib/review/idgxmlbuilder.rb

@@ -64,6 +64,7 @@ module ReVIEW
       @column = 0
       @noindent = nil
       @ol_num = nil
+      @first_line_num = nil
       @rootelement = "doc"
       @secttags = nil
       @tsize = nil
@@ -92,7 +93,7 @@ module ReVIEW
         s += "</sect>" if @section > 0
         s += "</chapter>" if @chapter.number > 0
       end
-      messages() + @output.string + s + "</#{@rootelement}>\n"
+      @output.string + s + "</#{@rootelement}>\n"
     end
 
     def warn(msg)
@@ -113,30 +114,6 @@ module ReVIEW
       end
     end
 
-    def messages
-      error_messages() + warning_messages()
-    end
-
-    def error_messages
-      return '' if @errors.empty?
-      "<h2>Syntax Errors</h2>\n" +
-      "<ul>\n" +
-      @errors.map {|file, line, msg|
-        "<li>#{escape_html(file)}:#{line}: #{escape_html(msg.to_s)}</li>\n"
-      }.join('') +
-      "</ul>\n"
-    end
-
-    def warning_messages
-      return '' if @warns.empty?
-      "<h2>Warnings</h2>\n" +
-      "<ul>\n" +
-      @warns.map {|file, line, msg|
-        "<li>#{escape_html(file)}:#{line}: #{escape_html(msg)}</li>\n"
-      }.join('') +
-      "</ul>\n"
-    end
-
     def headline(level, label, caption)
       case level
       when 1
@@ -162,7 +139,7 @@ module ReVIEW
         end
         @section += 1
         print %Q(<sect id="sect:#{@chapter.number}.#{@section}">) unless @secttags.nil?
-      
+
         @subsection = 0
         @subsubsection = 0
         @subsubsubsection = 0
@@ -212,10 +189,6 @@ module ReVIEW
       puts "<ul#{level == 1 ? nil : level}>"
     end
 
-    def ul_item(lines)
-      puts %Q(<li aid:pstyle="ul-item">#{lines.join.chomp}</li>)
-    end
-
     def ul_item_begin(lines)
       print %Q(<li aid:pstyle="ul-item">#{lines.join.chomp})
     end
@@ -310,9 +283,9 @@ module ReVIEW
 
     def inline_column_chap(chapter, id)
       if @book.config["chapterlink"]
-        %Q(<link href="#{column_label(id)}">#{escape_html(chapter.column(id).caption)}</link>)
+        %Q(<link href="#{column_label(id)}">#{I18n.t("column", compile_inline(chapter.column(id).caption))}</link>)
       else
-        escape_html(chapter.column(id).caption)
+        I18n.t("column", compile_inline(chapter.column(id).caption))
       end
     end
 
@@ -362,8 +335,9 @@ module ReVIEW
 
     def emlistnum(lines, caption = nil, lang = nil)
       _lines = []
+      first_line_num = get_line_num
       lines.each_with_index do |line, i|
-        _lines << detab("<span type='lineno'>" + (i + 1).to_s.rjust(2) + ": </span>" + line)
+        _lines << detab("<span type='lineno'>" + (i + first_line_num).to_s.rjust(2) + ": </span>" + line)
       end
       quotedlist _lines, 'emlistnum', caption
     end
@@ -371,6 +345,7 @@ module ReVIEW
     def listnum_body(lines, lang)
       print %Q(<pre>)
       no = 1
+      first_line_num = get_line_num
       lines.each_with_index do |line, i|
         unless @book.config["listinfo"].nil?
           print "<listinfo line=\"#{no}\""
@@ -378,7 +353,7 @@ module ReVIEW
           print " end=\"#{no}\"" if no == lines.size
           print ">"
         end
-        print detab("<span type='lineno'>" + (i + 1).to_s.rjust(2) + ": </span>" + line)
+        print detab("<span type='lineno'>" + (i + first_line_num).to_s.rjust(2) + ": </span>" + line)
         print "\n"
         print "</listinfo>" unless @book.config["listinfo"].nil?
         no += 1
@@ -532,7 +507,7 @@ module ReVIEW
           if cellwidth.size < col
             cw = (tablewidth - totallength) / (col - cellwidth.size)
             warn "auto cell sizing exceeds limit for table: #{id}" if cw <= 0
-            for i in cellwidth.size..(col - 1)
+            (cellwidth.size..(col - 1)).each do |i|
               cellwidth[i] = cw
             end
           end
@@ -589,7 +564,7 @@ module ReVIEW
 
     def table_header(id, caption)
       if get_chap.nil?
-      puts %Q[<caption>#{I18n.t("table")}#{I18n.t("format_number_without_chapter", [@chapter.table(id).number])}#{I18n.t("caption_prefix_idgxml")}#{compile_inline(caption)}</caption>]
+        puts %Q[<caption>#{I18n.t("table")}#{I18n.t("format_number_without_chapter", [@chapter.table(id).number])}#{I18n.t("caption_prefix_idgxml")}#{compile_inline(caption)}</caption>]
       else
         puts %Q[<caption>#{I18n.t("table")}#{I18n.t("format_number", [get_chap, @chapter.table(id).number])}#{I18n.t("caption_prefix_idgxml")}#{compile_inline(caption)}</caption>]
       end
@@ -627,8 +602,21 @@ module ReVIEW
       end
     end
 
-    def comment(str)
-      print %Q(<!-- [Comment] #{escape_html(str)} -->)
+    def comment(lines, comment = nil)
+      if @book.config["draft"]
+        lines ||= []
+        lines.unshift comment unless comment.blank?
+        str = lines.join("\n")
+        print "<msg>#{escape_html(str)}</msg>"
+      end
+    end
+
+    def inline_comment(str)
+      if @book.config["draft"]
+        %Q(<msg>#{escape_html(str)}</msg>)
+      else
+        ''
+      end
     end
 
     def footnote(id, str)
@@ -758,7 +746,7 @@ module ReVIEW
     end
 
     def inline_labelref(idref)
-      %Q[<ref idref='#{escape_html(idref)}'>「#{I18n.t("label_marker")}#{escape_html(idref)}」</ref>] # FIXME:節名とタイトルも込みで要出力
+      %Q[<ref idref='#{escape_html(idref)}'>「#{I18n.t("label_marker")}#{escape_html(idref)}」</ref>] # FIXME: 節名とタイトルも込みで要出力
     end
 
     alias_method :inline_ref, :inline_labelref
@@ -785,7 +773,7 @@ module ReVIEW
     end
 
     def linebreak
-      # FIXME:pが閉じちゃってるので一度戻らないといけないが、難しい…。
+      # FIXME: pが閉じちゃってるので一度戻らないといけないが、難しい…。
       puts "<br />"
     end
 
@@ -1045,10 +1033,6 @@ module ReVIEW
       print "<label id='#{id}' />"
     end
 
-    def tsize(str)
-      @tsize = str
-    end
-
     def dtp(str)
       print %Q(<?dtp #{str} ?>)
     end
@@ -1088,14 +1072,13 @@ module ReVIEW
 
     def inline_chapref(id)
       chs = ["", "「", "」"]
-      unless @book.config["chapref"].nil?
+      if @book.config["chapref"]
         _chs = @book.config["chapref"].split(",")
         if _chs.size != 3
           error "--chapsplitter must have exactly 3 parameters with comma."
         else
           chs = _chs
         end
-      else
       end
       s = "#{chs[0]}#{@book.chapter_index.number(id)}#{chs[1]}#{@book.chapter_index.title(id)}#{chs[2]}"
       if @book.config["chapterlink"]
@@ -1156,7 +1139,7 @@ module ReVIEW
     end
 
     def bibpaper_bibpaper(id, caption, lines)
-        print split_paragraph(lines).join("")
+      print split_paragraph(lines).join("")
     end
 
     def inline_bib(id)