RubyGems - rdoc - Versions diffs - 2.5 → 2.5.1 - Mend

rdoc 2.5 → 2.5.1

Potentially problematic release.

This version of rdoc might be problematic. Click here for more details.

Files changed (56) hide show

data.tar.gz.sig +0 -0
data/.autotest +1 -1
data/History.txt +41 -8
data/Manifest.txt +1 -0
data/lib/rdoc.rb +7 -7
data/lib/rdoc/any_method.rb +24 -8
data/lib/rdoc/attr.rb +13 -0
data/lib/rdoc/class_module.rb +5 -3
data/lib/rdoc/code_object.rb +0 -19
data/lib/rdoc/generator/darkfish.rb +44 -42
data/lib/rdoc/generator/template/darkfish/js/darkfish.js +5 -5
data/lib/rdoc/generator/template/darkfish/js/quicksearch.js +7 -7
data/lib/rdoc/generator/template/darkfish/rdoc.css +2 -2
data/lib/rdoc/markup.rb +7 -7
data/lib/rdoc/markup/parser.rb +1 -1
data/lib/rdoc/markup/preprocess.rb +1 -1
data/lib/rdoc/markup/to_html.rb +1 -1
data/lib/rdoc/options.rb +1 -1
data/lib/rdoc/parser.rb +5 -5
data/lib/rdoc/parser/c.rb +54 -17
data/lib/rdoc/parser/perl.rb +8 -8
data/lib/rdoc/parser/ruby.rb +24 -29
data/lib/rdoc/rdoc.rb +30 -18
data/lib/rdoc/ri/driver.rb +7 -15
data/lib/rdoc/ri/paths.rb +1 -2
data/lib/rdoc/ruby_lex.rb +12 -12
data/lib/rdoc/ruby_token.rb +4 -4
data/lib/rdoc/stats.rb +2 -2
data/lib/rdoc/task.rb +9 -5
data/test/test.txt +1 -0
data/test/test_rdoc_any_method.rb +50 -8
data/test/test_rdoc_attr.rb +8 -0
data/test/test_rdoc_class_module.rb +1 -1
data/test/test_rdoc_code_object.rb +2 -2
data/test/test_rdoc_constant.rb +1 -1
data/test/test_rdoc_context.rb +2 -2
data/test/test_rdoc_include.rb +1 -1
data/test/test_rdoc_markup_parser.rb +18 -0
data/test/test_rdoc_markup_to_ansi.rb +1 -1
data/test/test_rdoc_markup_to_html_crossref.rb +1 -1
data/test/test_rdoc_markup_to_rdoc.rb +1 -1
data/test/test_rdoc_normal_class.rb +1 -1
data/test/test_rdoc_normal_module.rb +1 -1
data/test/test_rdoc_parser.rb +2 -6
data/test/test_rdoc_parser_c.rb +20 -0
data/test/test_rdoc_parser_ruby.rb +1 -1
data/test/test_rdoc_rdoc.rb +2 -2
data/test/test_rdoc_require.rb +1 -1
data/test/test_rdoc_ri_driver.rb +27 -6
data/test/test_rdoc_ri_paths.rb +10 -6
data/test/test_rdoc_task.rb +9 -9
data/test/test_rdoc_top_level.rb +1 -1
data/test/xref_data.rb +1 -1
data/test/xref_test_case.rb +1 -1
metadata +4 -2
metadata.gz.sig +0 -0

data/lib/rdoc/generator/template/darkfish/rdoc.css CHANGED

@@ -1,9 +1,9 @@
 /*
  * "Darkfish" Rdoc CSS
  * $Id: rdoc.css 54 2009-01-27 01:09:48Z deveiant $
- *
+ *
  * Author: Michael Granger <ged@FaerieMUD.org>
- *
+ *
  */
 /* Base Green is: #6C8C22 */

data/lib/rdoc/markup.rb CHANGED

@@ -27,9 +27,9 @@ require 'rdoc'
 # convert multiple input strings.
 #
 #   require 'rdoc/markup/to_html'
-#
+#
 #   h = RDoc::Markup::ToHtml.new
-#
+#
 #   puts h.convert(input_string)
 #
 # You can extend the RDoc::Markup parser to recognise new markup
@@ -41,22 +41,22 @@ require 'rdoc'
 #
 #   require 'rdoc/markup'
 #   require 'rdoc/markup/to_html'
-#
+#
 #   class WikiHtml < RDoc::Markup::ToHtml
 #     def handle_special_WIKIWORD(special)
 #       "<font color=red>" + special.text + "</font>"
 #     end
 #   end
-#
+#
 #   m = RDoc::Markup.new
 #   m.add_word_pair("{", "}", :STRIKE)
 #   m.add_html("no", :STRIKE)
-#
+#
 #   m.add_special(/\b([A-Z][a-z]+[A-Z]\w+)/, :WIKIWORD)
-#
+#
 #   wh = WikiHtml.new
 #   wh.add_tag(:STRIKE, "<strike>", "</strike>")
-#
+#
 #   puts "<body>#{wh.convert ARGF.read}</body>"
 #
 #--

data/lib/rdoc/markup/parser.rb CHANGED

@@ -463,7 +463,7 @@ class RDoc::Markup::Parser
                    token
                  when s.scan(/ +/) then
                    [:INDENT, s.matched_size, *token_pos(pos)]
-                 when s.scan(/(=+)\s+/) then
+                 when s.scan(/(=+)\s*/) then
                    level = s[1].length
                    level = 6 if level > 6
                    @tokens << [:HEADER, level, *token_pos(pos)]

data/lib/rdoc/markup/preprocess.rb CHANGED

@@ -67,7 +67,7 @@ class RDoc::Markup::PreProcess
   # and then in each of the directories specified in the RDOC_INCLUDE path
   def find_include_file(name)
-    to_search = [ File.dirname(@input_file_name) ].concat @include_path
+    to_search = [File.dirname(@input_file_name)].concat @include_path
     to_search.each do |dir|
       full_name = File.join(dir, name)
       stat = File.stat(full_name) rescue next

data/lib/rdoc/markup/to_html.rb CHANGED

@@ -290,7 +290,7 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   # Determins the HTML list element for +list_type+ and +open_tag+
   def html_list_name(list_type, open_tag)
-    tags = LIST_TYPE_TO_HTML[list_type]
+    tags = LIST_TYPE_TO_HTML[list_type]
     raise RDoc::Error, "Invalid list type: #{list_type.inspect}" unless tags
     annotate tags[open_tag ? 0 : 1]
   end

data/lib/rdoc/options.rb CHANGED

@@ -193,7 +193,7 @@ Usage: #{opt.program_name} [options] [names...]
       opt.separator nil
-      opt.on("--force-update", "-U",
+      opt.on("--[no-]force-update", "-U",
              "Forces rdoc to scan all sources even if",
              "newer than the flag file.") do |value|
         @force_update = value

data/lib/rdoc/parser.rb CHANGED

@@ -22,14 +22,14 @@ require 'rdoc/stats'
 # following incantation
 #
 #   require "rdoc/parser"
-#
+#
 #   class RDoc::Parser::Xyz < RDoc::Parser
 #     parse_files_matching /\.xyz$/ # <<<<
-#
+#
 #     def initialize(file_name, body, options)
 #       ...
 #     end
-#
+#
 #     def scan
 #       ...
 #     end
@@ -67,7 +67,7 @@ class RDoc::Parser
   # content that an RDoc parser shouldn't try to consume.
   def self.binary?(file)
-    s = File.read(file, File.stat(file).blksize) || ""
+    s = File.read(file, 1024) or return false
     if s[0, 2] == Marshal.dump('')[0, 2] then
       true
@@ -89,7 +89,7 @@ class RDoc::Parser
   def self.zip? file
     zip_signature = File.read file, 4
     zip_signature == "PK\x03\x04" or
       zip_signature == "PK\x05\x06" or
       zip_signature == "PK\x07\x08"

data/lib/rdoc/parser/c.rb CHANGED

@@ -65,7 +65,7 @@ require 'rdoc/known_classes'
 # Ruby function is in the same source file as the rb_define_method call.
 # If this isn't the case, add the comment:
 #
-#   rb_define_method(....);  // in: filename
+#   rb_define_method(....);  // in filename
 #
 # As an example, we might have an extension that defines multiple classes
 # in its Init_xxx method. We could document them using
@@ -76,7 +76,7 @@ require 'rdoc/known_classes'
 #    * Encapsulate the writing and reading of the configuration
 #    * file. ...
 #    */
-#
+#
 #   /*
 #    * Document-method: read_value
 #    *
@@ -227,8 +227,8 @@ class RDoc::Parser::C < RDoc::Parser
       next if var_name == "argf"   # it'd be nice to handle this one
       var_name = "rb_cObject" if var_name == "rb_mKernel"
-      handle_method(type, var_name, meth_name,
-                    meth_body, param_count, source_file)
+      handle_method(type, var_name, meth_name, meth_body, param_count,
+                    source_file)
     end
     @content.scan(%r{rb_define_attr\(
@@ -304,7 +304,7 @@ class RDoc::Parser::C < RDoc::Parser
       find_modifiers comment, meth_obj if comment
-#        meth_obj.params = params
+      #meth_obj.params = params
       meth_obj.start_collecting_tokens
       tk = RDoc::RubyToken::Token.new nil, 1, 1
       tk.set_text body_text
@@ -390,14 +390,20 @@ class RDoc::Parser::C < RDoc::Parser
         void\s+
         Init_#{class_name}\s*(?:_\(\s*)?\(\s*(?:void\s*)?\)}xmi then # )
       comment = $1
-    elsif @content =~ %r{Document-(?:class|module):\s+#{class_name}\s*?(?:<\s+[:,\w]+)?\n((?>.*?\*/))}m then
+    elsif @content =~ %r{Document-(?:class|module):\s+#{class_name}\s*?(?:<\s+[:,\w]+)?\n((?>.*?\*/))}m then # "
       comment = $1
     elsif @content =~ %r{((?>/\*.*?\*/\s+))
                          ([\w\.\s]+\s* = \s+)?rb_define_(class|module).*?"(#{class_name})"}xm then
       comment = $1
     end
-    class_mod.comment = strip_stars comment if comment
+    return unless comment
+    comment = strip_stars comment
+    comment = look_for_directives_in class_mod, comment
+    class_mod.comment = comment
   end
   ##
@@ -479,7 +485,7 @@ class RDoc::Parser::C < RDoc::Parser
       end
       unless enclosure then
-        warn("Enclosing class/module '#{in_module}' for #{type} #{class_name} not known")
+        warn "Enclosing class/module '#{in_module}' for #{type} #{class_name} not known"
         return
       end
     else
@@ -601,9 +607,9 @@ class RDoc::Parser::C < RDoc::Parser
       meth_obj = RDoc::AnyMethod.new '', meth_name
       meth_obj.singleton = %w[singleton_method module_function].include? type
-      p_count = (Integer(param_count) rescue -1)
+      p_count = Integer(param_count) rescue -1
-      if p_count < 0
+      if p_count < 0 then
         meth_obj.params = "(...)"
       elsif p_count == 0
         meth_obj.params = "()"
@@ -611,11 +617,14 @@ class RDoc::Parser::C < RDoc::Parser
         meth_obj.params = "(" + (1..p_count).map{|i| "p#{i}"}.join(", ") + ")"
       end
-      if source_file and File.exist? source_file then
-        file_name = File.join(@file_dir, source_file)
-        body = (@@known_bodies[source_file] ||= File.read(file_name))
-      elsif source_file then
-        warn "unknown source file #{source_file}"
+      if source_file then
+        file_name = File.join @file_dir, source_file
+        if File.exist? file_name then
+          body = (@@known_bodies[file_name] ||= File.read(file_name))
+        else
+          warn "unknown source #{source_file} for #{meth_name} in #{@file_name}"
+        end
       else
         body = @content
       end
@@ -640,6 +649,34 @@ class RDoc::Parser::C < RDoc::Parser
     end
   end
+  ##
+  # Look for directives in a normal comment block:
+  #
+  #   /*
+  #    * :title: My Awesome Project
+  #    */
+  #
+  # This routine modifies it's parameter
+  def look_for_directives_in(context, comment)
+    preprocess = RDoc::Markup::PreProcess.new @file_name, @options.rdoc_include
+    preprocess.handle comment do |directive, param|
+      case directive
+      when 'main' then
+        @options.main_page = param
+        ''
+      when 'title' then
+        @options.title = param
+        ''
+      else
+        warn "Unrecognized directive :#{directive}:"
+        false
+      end
+    end
+    comment
+  end
   ##
   # Removes lines that are commented out that might otherwise get picked up
   # when scanning for classes and methods
@@ -649,8 +686,8 @@ class RDoc::Parser::C < RDoc::Parser
   end
   def remove_private_comments(comment)
-     comment.gsub!(/\/?\*--\n(.*?)\/?\*\+\+/m, '')
-     comment.sub!(/\/?\*--\n.*/m, '')
+    comment.gsub!(/\/?\*--\n(.*?)\/?\*\+\+/m, '')
+    comment.sub!(/\/?\*--\n.*/m, '')
   end
   ##

data/lib/rdoc/parser/perl.rb CHANGED

@@ -15,7 +15,7 @@ require 'rdoc/parser'
 #
 # We would like to support all the markup the POD provides
 # so that it will convert happily to HTML.  At the moment
-# I don't think I can do that: time constraints.
+# I don't think I can do that: time constraints.
 #
 class RDoc::Parser::PerlPOD < RDoc::Parser
@@ -45,39 +45,39 @@ class RDoc::Parser::PerlPOD < RDoc::Parser
   # but I think it would obscure the intent, scatter the
   # code all over tha place.  This machine is necessary
   # because POD requires that directives be preceded by
-  # blank lines, so reading line by line is necessary,
+  # blank lines, so reading line by line is necessary,
   # and preserving state about what is seen is necesary.
   def scan
     @top_level.comment ||= ""
-    state=:code_blank
+    state=:code_blank
     line_number = 0
     line = nil
     # This started out as a really long nested case statement,
     # which also led to repetitive code.  I'd like to avoid that
     # so I'm using a "table" instead.
     # Firstly we need some procs to do the transition and processing
     # work.  Because these are procs they are closures, and they can
     # use variables in the local scope.
     #
     # First, the "nothing to see here" stuff.
-    code_noop = lambda do
+    code_noop = lambda do
       if line =~ /^\s+$/
 	state = :code_blank
       end
     end
-    pod_noop = lambda do
+    pod_noop = lambda do
       if line =~ /^\s+$/
 	state = :pod_blank
       end
       @top_level.comment += filter(line)
     end
-    begin_noop = lambda do
+    begin_noop = lambda do
       if line =~ /^\s+$/
 	state = :begin_blank
       end
@@ -151,7 +151,7 @@ class RDoc::Parser::PerlPOD < RDoc::Parser
   def filter(comment)
     return '' if comment =~ /^=pod\s*$/
     comment.gsub!(/^=pod/, '==')
-    comment.gsub!(/^=head(\d+)/) do
+    comment.gsub!(/^=head(\d+)/) do
       "=" * $1.to_i
     end
     comment.gsub!(/=item/, '');

data/lib/rdoc/parser/ruby.rb CHANGED

@@ -50,7 +50,7 @@ $TOKEN_DEBUG ||= nil
 #
 #   ##
 #   # This method tries over and over until it is tired
-#
+#
 #   def go_go_go(thing_to_try, tries = 10) # :args: thing_to_try
 #     puts thing_to_try
 #     go_go_go thing_to_try, tries - 1
@@ -70,7 +70,7 @@ $TOKEN_DEBUG ||= nil
 #   # :call-seq:
 #   #   my_method(Range)
 #   #   my_method(offset, length)
-#
+#
 #   def my_method(*args)
 #   end
 #
@@ -81,7 +81,7 @@ $TOKEN_DEBUG ||= nil
 #
 #   ##
 #   # My method is awesome
-#
+#
 #   def my_method(&block) # :yields: happy, times
 #     block.call 1, 2
 #   end
@@ -93,7 +93,7 @@ $TOKEN_DEBUG ||= nil
 #
 #   ##
 #   # This is a meta-programmed method!
-#
+#
 #   add_my_method :meta_method, :arg1, :arg2
 #
 # The parser looks at the token after the identifier to determine the name, in
@@ -131,14 +131,14 @@ $TOKEN_DEBUG ||= nil
 #   ##
 #   # :attr_writer: ghost_writer
 #   # There is an attribute here, but you can't see it!
-#
+#
 #   ##
 #   # :method: ghost_method
 #   # There is a method here, but you can't see it!
-#
+#
 #   ##
 #   # this is a comment for a regular method
-#
+#
 #   def regular_method() end
 #
 # Note that by default, the :method: directive will be ignored if there is a
@@ -212,7 +212,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
   def error(msg)
     msg = make_message msg
     $stderr.puts msg
-    exit(1)
+    exit false
   end
   ##
@@ -377,10 +377,9 @@ class RDoc::Parser::Ruby < RDoc::Parser
   # This routine modifies it's parameter
   def look_for_directives_in(context, comment)
-    preprocess = RDoc::Markup::PreProcess.new(@file_name,
-                                              @options.rdoc_include)
+    preprocess = RDoc::Markup::PreProcess.new @file_name, @options.rdoc_include
-    preprocess.handle(comment) do |directive, param|
+    preprocess.handle comment do |directive, param|
       case directive
       when 'enddoc' then
         throw :enddoc
@@ -391,7 +390,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
            'attr', 'attr_accessor', 'attr_reader', 'attr_writer' then
         false # handled elsewhere
       when 'section' then
-        context.set_current_section(param, comment)
+        context.set_current_section param, comment
         comment.replace ''
         break
       when 'startdoc' then
@@ -405,7 +404,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
         @options.title = param
         ''
       else
-        warn "Unrecognized directive '#{directive}'"
+        warn "Unrecognized directive :#{directive}:"
         false
       end
     end
@@ -417,7 +416,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
   # Adds useful info about the parser to +message+
   def make_message message
-    prefix = "\n#{@file_name}:"
+    prefix = "#{@file_name}:"
     prefix << "#{@scanner.line_no}:#{@scanner.char_no}:" if @scanner
@@ -737,27 +736,27 @@ class RDoc::Parser::Ruby < RDoc::Parser
   # To create foo and bar attributes on class C with comment "My attributes":
   #
   #   class C
-  #
+  #
   #     ##
   #     # :attr:
   #     #
   #     # My attributes
-  #
+  #
   #     my_attr :foo, :bar
-  #
+  #
   #   end
   #
   # To create a foo attribute on class C with comment "My attribute":
   #
   #   class C
-  #
+  #
   #     ##
   #     # :attr: foo
   #     #
   #     # My attribute
-  #
+  #
   #     my_attr :foo, :bar
-  #
+  #
   #   end
   def parse_meta_attr(context, single, tk, comment)
@@ -1405,16 +1404,12 @@ class RDoc::Parser::Ruby < RDoc::Parser
     end
   end
-  def parse_yield_parameters
-    parse_method_or_yield_parameters
-  end
   def parse_yield(context, single, tk, method)
-    if method.block_params.nil?
-      get_tkread
-      @scanner.instance_eval{@continue = false}
-      method.block_params = parse_yield_parameters
-    end
+    return if method.block_params
+    get_tkread
+    @scanner.instance_eval { @continue = false }
+    method.block_params = parse_method_or_yield_parameters
   end
   ##