rdoc 4.0.0 → 4.0.1

data/lib/rdoc/markdown/literals_1_8.kpeg

@@ -12,7 +12,7 @@
 Alphanumeric      = /[0-9A-Za-z\200-\377]/
 AlphanumericAscii = /[A-Za-z0-9]/
 BOM               = "\357\273\277"
-Newline           = "\n" | "\r" "\n"?
+Newline           = /\n|\r\n?/
 NonAlphanumeric   = /[\000-\057\072-\100\133-\140\173-\177]/
-Spacechar         = " " | "\t"
+Spacechar         = / |\t/
 

data/lib/rdoc/markdown/literals_1_8.rb

@@ -381,39 +381,9 @@ class RDoc::Markdown::Literals
     return _tmp
   end
 
-  # Newline = ("\n" | "
+  # Newline = /\n|\r\n?/
   def _Newline
-
-    _save = self.pos
-    while true # choice
-      _tmp = match_string("\n")
-      break if _tmp
-      self.pos = _save
-
-      _save1 = self.pos
-      while true # sequence
-        _tmp = match_string("\r")
-        unless _tmp
-          self.pos = _save1
-          break
-        end
-        _save2 = self.pos
-        _tmp = match_string("\n")
-        unless _tmp
-          _tmp = true
-          self.pos = _save2
-        end
-        unless _tmp
-          self.pos = _save1
-        end
-        break
-      end # end sequence
-
-      break if _tmp
-      self.pos = _save
-      break
-    end # end choice
-
+    _tmp = scan(/\A(?-mix:\n|\r\n?)/)
     set_failed_rule :_Newline unless _tmp
     return _tmp
   end
@@ -425,20 +395,9 @@ class RDoc::Markdown::Literals
     return _tmp
   end
 
-  # Spacechar = (" " | "\t")
+  # Spacechar = / |\t/
   def _Spacechar
-
-    _save = self.pos
-    while true # choice
-      _tmp = match_string(" ")
-      break if _tmp
-      self.pos = _save
-      _tmp = match_string("\t")
-      break if _tmp
-      self.pos = _save
-      break
-    end # end choice
-
+    _tmp = scan(/\A(?-mix: |\t)/)
     set_failed_rule :_Spacechar unless _tmp
     return _tmp
   end
@@ -447,8 +406,8 @@ class RDoc::Markdown::Literals
   Rules[:_Alphanumeric] = rule_info("Alphanumeric", "/[0-9A-Za-z\\200-\\377]/")
   Rules[:_AlphanumericAscii] = rule_info("AlphanumericAscii", "/[A-Za-z0-9]/")
   Rules[:_BOM] = rule_info("BOM", "\"\"")
-  Rules[:_Newline] = rule_info("Newline", "(\"\\n\" | \"
+  Rules[:_Newline] = rule_info("Newline", "/\\n|\\r\\n?/")
   Rules[:_NonAlphanumeric] = rule_info("NonAlphanumeric", "/[\\000-\\057\\072-\\100\\133-\\140\\173-\\177]/")
-  Rules[:_Spacechar] = rule_info("Spacechar", "(\" \" | \"\\t\")")
+  Rules[:_Spacechar] = rule_info("Spacechar", "/ |\\t/")
   # :startdoc:
 end

data/lib/rdoc/markup.rb

@@ -59,7 +59,7 @@
 #
 #   require 'rdoc'
 #
-#   h = RDoc::Markup::ToHtml.new
+#   h = RDoc::Markup::ToHtml.new(RDoc::Options.new)
 #
 #   puts h.convert(input_string)
 #

data/lib/rdoc/markup/to_html.rb

@@ -176,6 +176,7 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   def accept_paragraph paragraph
     @res << "\n<p>"
     text = paragraph.text @hard_break
+    text = text.gsub(/\r?\n/, ' ')
     @res << wrap(to_html(text))
     @res << "</p>\n"
   end
@@ -186,19 +187,26 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   def accept_verbatim verbatim
     text = verbatim.text.rstrip
 
-    @res << if verbatim.ruby? or parseable? text then
-              begin
-                tokens = RDoc::RubyLex.tokenize text, @options
+    klass = nil
 
-                html = RDoc::TokenStream.to_html tokens
+    content = if verbatim.ruby? or parseable? text then
+                begin
+                  tokens = RDoc::RubyLex.tokenize text, @options
+                  klass  = ' class="ruby"'
 
-                "\n<pre class=\"ruby\">#{html}</pre>\n"
-              rescue RDoc::RubyLex::Error
-                "\n<pre>#{CGI.escapeHTML text}</pre>\n"
+                  RDoc::TokenStream.to_html tokens
+                rescue RDoc::RubyLex::Error
+                  CGI.escapeHTML text
+                end
+              else
+                CGI.escapeHTML text
               end
-            else
-              "\n<pre>#{CGI.escapeHTML text}</pre>\n"
-            end
+
+    if @options.pipe then
+      @res << "\n<pre><code>#{CGI.escapeHTML text}</code></pre>\n"
+    else
+      @res << "\n<pre#{klass}>#{content}</pre>\n"
+    end
   end
 
   ##

data/lib/rdoc/options.rb

@@ -52,6 +52,18 @@ require 'pathname'
 #     end
 #   end
 #
+# Of course, RDoc::Options does not respond to +spell_dictionary+ by default
+# so you will need to add it:
+#
+#   class RDoc::Options
+#
+#     ##
+#     # The spell dictionary used by the spell-checking plugin.
+#
+#     attr_accessor :spell_dictionary
+#
+#   end
+#
 # == Option Validators
 #
 # OptionParser validators will validate and cast user input values.  In
@@ -916,7 +928,7 @@ Usage: #{opt.program_name} [options] [names...]
         check_generator
 
         @generator_name = "ri"
-        @op_dir = RDoc::RI::Paths::SITEDIR
+        @op_dir = RDoc::RI::Paths.site_dir
         setup_generator
       end
 
@@ -991,7 +1003,7 @@ Usage: #{opt.program_name} [options] [names...]
 
     begin
       opts.parse! argv
-    rescue OptionParser::InvalidArgument, OptionParser::InvalidOption => e
+    rescue OptionParser::ParseError => e
       if DEPRECATED[e.args.first] then
         deprecated << e.args.first
       elsif %w[--format --ri -r --ri-site -R].include? e.args.first then
@@ -1017,18 +1029,22 @@ Usage: #{opt.program_name} [options] [names...]
       deprecated.each do |opt|
         $stderr.puts 'option ' << opt << ' is deprecated: ' << DEPRECATED[opt]
       end
+    end
 
-      unless invalid.empty? then
-        invalid = "invalid options: #{invalid.join ', '}"
+    unless invalid.empty? then
+      invalid = "invalid options: #{invalid.join ', '}"
 
-        if ignore_invalid then
+      if ignore_invalid then
+        unless quiet then
           $stderr.puts invalid
           $stderr.puts '(invalid options are ignored)'
-        else
+        end
+      else
+        unless quiet then
           $stderr.puts opts
-          $stderr.puts invalid
-          exit 1
         end
+        $stderr.puts invalid
+        exit 1
       end
     end
 

data/lib/rdoc/parser.rb

@@ -218,6 +218,8 @@ class RDoc::Parser
 
     return unless parser
 
+    content = remove_modeline content
+
     parser.new top_level, file_name, content, options, stats
   rescue SystemCallError
     nil
@@ -232,6 +234,13 @@ class RDoc::Parser
     RDoc::Parser.parsers.unshift [regexp, self]
   end
 
+  ##
+  # Removes an emacs-style modeline from the first line of the document
+
+  def self.remove_modeline content
+    content.sub(/\A.*-\*-\s*(.*?\S)\s*-\*-.*\r?\n/, '')
+  end
+
   ##
   # If there is a <tt>markup: parser_name</tt> comment at the front of the
   # file, use it to determine the parser.  For example:

data/lib/rdoc/parser/c.rb

@@ -173,6 +173,9 @@ class RDoc::Parser::C < RDoc::Parser
     @classes           = load_variable_map :c_class_variables
     @singleton_classes = load_variable_map :c_singleton_class_variables
 
+    # class_variable => { function => [method, ...] }
+    @methods = Hash.new { |h, f| h[f] = Hash.new { |i, m| i[m] = [] } }
+
     # missing variable => [handle_class_module arguments]
     @missing_dependencies = {}
 
@@ -206,6 +209,41 @@ class RDoc::Parser::C < RDoc::Parser
     end
   end
 
+  ##
+  # Removes duplicate call-seq entries for methods using the same
+  # implementation.
+
+  def deduplicate_call_seq
+    @methods.each do |var_name, functions|
+      class_name = @known_classes[var_name]
+      class_obj  = find_class var_name, class_name
+
+      functions.each_value do |method_names|
+        next if method_names.length == 1
+
+        method_names.each do |method_name|
+          deduplicate_method_name class_obj, method_name
+        end
+      end
+    end
+  end
+
+  def deduplicate_method_name class_obj, method_name
+    return unless
+      method = class_obj.method_list.find { |m| m.name == method_name }
+    return unless call_seq = method.call_seq
+
+    method_name = method_name[0, 1] unless method_name =~ /\A\w/
+
+      entries = call_seq.split "\n"
+
+    matching = entries.select do |entry|
+      entry =~ /^\w*\.?#{Regexp.escape method_name}/
+    end
+
+    method.call_seq = matching.join "\n"
+  end
+
   ##
   # Scans #content for rb_define_alias
 
@@ -422,7 +460,7 @@ class RDoc::Parser::C < RDoc::Parser
                    )
                    \s*\(\s*([\w\.]+),
                      \s*"([^"]+)",
-                     \s*(?:RUBY_METHOD_FUNC\(|VALUEFUNC\()?(\w+)\)?,
+                     \s*(?:RUBY_METHOD_FUNC\(|VALUEFUNC\(|\(METHOD\))?(\w+)\)?,
                      \s*(-?\w+)\s*\)
                    (?:;\s*/[*/]\s+in\s+(\w+?\.(?:cpp|c|y)))?
                  %xm) do |type, var_name, meth_name, function, param_count, source_file|
@@ -938,6 +976,8 @@ class RDoc::Parser::C < RDoc::Parser
     class_name = @known_classes[var_name]
     singleton  = @singleton_classes.key? var_name
 
+    @methods[var_name][function] << meth_name
+
     return unless class_name
 
     class_obj = find_class var_name, class_name
@@ -1172,6 +1212,8 @@ class RDoc::Parser::C < RDoc::Parser
     do_aliases
     do_attrs
 
+    deduplicate_call_seq
+
     @store.add_c_variables self
 
     @top_level

data/lib/rdoc/rdoc.rb

@@ -342,6 +342,8 @@ option)
 
     @stats.add_file filename
 
+    return if RDoc::Parser.binary? filename
+
     content = RDoc::Encoding.read_file filename, encoding
 
     return unless content

data/lib/rdoc/ri/driver.rb

@@ -1412,7 +1412,9 @@ The ri pager can be set with the 'RI_PAGER' environment variable or the
 
     server = WEBrick::HTTPServer.new :Port => @server
 
-    server.mount '/', RDoc::Servlet
+    extra_doc_dirs = @stores.map {|s| s.type == :extra ? s.path : nil}.compact
+
+    server.mount '/', RDoc::Servlet, nil, extra_doc_dirs
 
     trap 'INT'  do server.shutdown end
     trap 'TERM' do server.shutdown end

data/lib/rdoc/ruby_lex.rb

@@ -1028,6 +1028,8 @@ class RDoc::RubyLex
     end
 
     if output_heredoc then
+      raise Error, "Missing terminating #{quoted} for string" unless l
+
       doc << l.chomp
     else
       doc << '"'

data/lib/rdoc/rubygems_hook.rb

@@ -12,6 +12,7 @@ require 'rdoc'
 class RDoc::RubygemsHook
 
   include Gem::UserInteraction
+  extend  Gem::UserInteraction
 
   @rdoc_version = nil
   @specs = []
@@ -45,7 +46,8 @@ class RDoc::RubygemsHook
   # +specs+
 
   def self.generation_hook installer, specs
-    types     = installer.document
+    start = Time.now
+    types = installer.document
 
     generate_rdoc = types.include? 'rdoc'
     generate_ri   = types.include? 'ri'
@@ -53,6 +55,13 @@ class RDoc::RubygemsHook
     specs.each do |spec|
       new(spec, generate_rdoc, generate_ri).generate
     end
+
+    return unless generate_rdoc or generate_ri
+
+    duration = (Time.now - start).to_i
+    names    = specs.map(&:name).join ', '
+
+    say "Done installing documentation for #{names} after #{duration} seconds"
   end
 
   ##

data/lib/rdoc/servlet.rb

@@ -53,14 +53,17 @@ class RDoc::Servlet < WEBrick::HTTPServlet::AbstractServlet
   #
   # Use +mount_path+ when mounting the servlet somewhere other than /.
   #
+  # Use +extra_doc_dirs+ for additional documentation directories.
+  #
   # +server+ is provided automatically by WEBrick when mounting.  +stores+ and
   # +cache+ are provided automatically by the servlet.
 
-  def initialize server, stores, cache, mount_path = nil
+  def initialize server, stores, cache, mount_path = nil, extra_doc_dirs = []
     super server
 
     @cache      = cache
     @mount_path = mount_path
+    @extra_doc_dirs = extra_doc_dirs
     @stores     = stores
 
     @options = RDoc::Options.new
@@ -270,6 +273,7 @@ version.  If you're viewing Ruby's documentation, include the version of ruby.
   # and the filesystem to the RDoc::Store for the documentation.
 
   def installed_docs
+    extra_counter = 0
     ri_paths.map do |path, type|
       store = RDoc::Store.new path, type
       exists = File.exist? store.cache_path
@@ -284,6 +288,11 @@ version.  If you're viewing Ruby's documentation, include the version of ruby.
         ['Site Documentation', 'site/', exists, type, path]
       when :home then
         ['Home Documentation', 'home/', exists, type, path]
+      when :extra then
+        extra_counter += 1
+        store.load_cache if exists
+        title = store.title || "Extra Documentation"
+        [title, "extra-#{extra_counter}/", exists, type, path]
       end
     end
   end
@@ -300,7 +309,7 @@ version.  If you're viewing Ruby's documentation, include the version of ruby.
   # Enumerates the ri paths.  See RDoc::RI::Paths#each
 
   def ri_paths &block
-    RDoc::RI::Paths.each true, true, true, :all, &block
+    RDoc::RI::Paths.each true, true, true, :all, *@extra_doc_dirs, &block #TODO: pass extra_dirs
   end
 
   ##
@@ -344,6 +353,8 @@ version.  If you're viewing Ruby's documentation, include the version of ruby.
       when :home then
         path    = 'home'
         comment = 'Documentation from your home directory'
+      when :extra
+        comment = name
       end
 
       info << [name, '', path, '', comment]
@@ -397,6 +408,10 @@ version.  If you're viewing Ruby's documentation, include the version of ruby.
       RDoc::Store.new RDoc::RI::Paths.system_dir, :system
     when 'site' then
       RDoc::Store.new RDoc::RI::Paths.site_dir, :site
+    when /^extra-(\d+)$/ then
+      index = $1.to_i - 1
+      ri_dir = installed_docs[index][4]
+      RDoc::Store.new ri_dir, :extra
     else
       ri_dir, type = ri_paths.find do |dir, dir_type|
         next unless dir_type == :gem

data/lib/rdoc/text.rb

@@ -140,7 +140,7 @@ module RDoc::Text
   def snippet text, limit = 100
     document = parse text
 
-    RDoc::Markup::ToHtmlSnippet.new(limit).convert document
+    RDoc::Markup::ToHtmlSnippet.new(options, limit).convert document
   end
 
   ##

data/test/test_rdoc_class_module.rb

@@ -165,6 +165,7 @@ class TestRDocClassModule < XrefTestCase
     ns = tl.add_module RDoc::NormalModule, 'Namespace'
 
     cm = ns.add_class RDoc::NormalClass, 'Klass', 'Super'
+    cm.document_self = true
     cm.record_location tl
 
     a1 = RDoc::Attr.new nil, 'a1', 'RW', ''
@@ -236,6 +237,58 @@ class TestRDocClassModule < XrefTestCase
     assert_equal tl, loaded.method_list.first.file
   end
 
+  def test_marshal_dump_visibilty
+    @store.path = Dir.tmpdir
+    tl = @store.add_file 'file.rb'
+
+    ns = tl.add_module RDoc::NormalModule, 'Namespace'
+
+    cm = ns.add_class RDoc::NormalClass, 'Klass', 'Super'
+    cm.record_location tl
+
+    a1 = RDoc::Attr.new nil, 'a1', 'RW', ''
+    a1.record_location tl
+    a1.document_self = false
+
+    m1 = RDoc::AnyMethod.new nil, 'm1'
+    m1.record_location tl
+    m1.document_self = false
+
+    c1 = RDoc::Constant.new 'C1', nil, ''
+    c1.record_location tl
+    c1.document_self = false
+
+    i1 = RDoc::Include.new 'I1', ''
+    i1.record_location tl
+    i1.document_self = false
+
+    e1 = RDoc::Extend.new 'E1', ''
+    e1.record_location tl
+    e1.document_self = false
+
+    section_comment = RDoc::Comment.new('section comment')
+    section_comment.location = tl
+
+    assert_equal 1, cm.sections.length, 'sanity, default section only'
+
+    cm.add_attribute a1
+    cm.add_method m1
+    cm.add_constant c1
+    cm.add_include i1
+    cm.add_extend e1
+    cm.add_comment 'this is a comment', tl
+
+    loaded = Marshal.load Marshal.dump cm
+    loaded.store = @store
+
+    assert_equal cm, loaded
+
+    assert_empty loaded.attributes
+    assert_empty loaded.constants
+    assert_empty loaded.includes
+    assert_empty loaded.extends
+    assert_empty loaded.method_list
+  end
   def test_marshal_load_version_0
     tl = @store.add_file 'file.rb'
     ns = tl.add_module RDoc::NormalModule, 'Namespace'