rdoc 2.4.1 → 2.4.2

data/lib/rdoc/ri/driver.rb

@@ -550,8 +550,8 @@ Options may also be set in the 'RI' environment variable.
 
           cache = load_cache_for klass
 
-          methods += cache.keys.select do |name|
-            name =~ /^#{klass}#{method_type}#{method}/
+          methods += cache.keys.select do |method_name|
+            method_name =~ /^#{klass}#{method_type}#{method}/
           end
 
           # TODO ancestor lookup
@@ -609,7 +609,7 @@ Options may also be set in the 'RI' environment variable.
       expanded << '::' unless expanded.empty?
       short = expanded << klass_part
 
-      subset = class_cache.keys.select do |klass|
+      subset = class_cache.keys.select do |klass_name|
         klass =~ /^#{expanded}[^:]*$/
       end
 
@@ -673,8 +673,8 @@ Options may also be set in the 'RI' environment variable.
         if system_file then
           method["source_path"] = "Ruby #{RDoc::RI::Paths::VERSION}"
         else
-          gem = Gem.path.any? do |path|
-            pattern = File.join Regexp.escape(path), 'doc', '(.*?)', ''
+          gem = Gem.path.any? do |gem_path|
+            pattern = File.join Regexp.escape(gem_path), 'doc', '(.*?)', ''
 
             f =~ /^#{pattern}/
           end

data/lib/rdoc/task.rb

@@ -0,0 +1,276 @@
+# Copyright (c) 2003, 2004 Jim Weirich, 2009 Eric Hodel
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'rubygems'
+begin
+  gem 'rdoc'
+rescue Gem::LoadError
+end
+
+begin
+  gem 'rake'
+rescue Gem::LoadError
+end
+
+require 'rdoc'
+require 'rake'
+require 'rake/tasklib'
+
+##
+# Create a documentation task that will generate the RDoc files for a project.
+#
+# The RDoc::Task will create the following targets:
+#
+# [<b><em>rdoc</em></b>]
+#   Main task for this RDoc task.
+#
+# [<b>:clobber_<em>rdoc</em></b>]
+#   Delete all the rdoc files.  This target is automatically added to the main
+#   clobber target.
+#
+# [<b>:re<em>rdoc</em></b>]
+#   Rebuild the rdoc files from scratch, even if they are not out of date.
+#
+# Simple Example:
+#
+#   RDoc::Task.new do |rd|
+#     rd.main = "README.rdoc"
+#     rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+#   end
+#
+# The +rd+ object passed to the block is an RDoc::Task object. See the
+# attributes list for the RDoc::Task class for available customization options.
+#
+# == Specifying different task names
+#
+# You may wish to give the task a different name, such as if you are
+# generating two sets of documentation.  For instance, if you want to have a
+# development set of documentation including private methods:
+#
+#   RDoc::Task.new :rdoc_dev do |rd|
+#     rd.main = "README.doc"
+#     rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+#     rd.options << "--all"
+#   end
+#
+# The tasks would then be named :<em>rdoc_dev</em>,
+# :clobber_<em>rdoc_dev</em>, and :re<em>rdoc_dev</em>.
+#
+# If you wish to have completely different task names, then pass a Hash as
+# first argument. With the <tt>:rdoc</tt>, <tt>:clobber_rdoc</tt> and
+# <tt>:rerdoc</tt> options, you can customize the task names to your liking.
+#
+# For example:
+#
+#   RDoc::Task.new(:rdoc => "rdoc", :clobber_rdoc => "rdoc:clean",
+#                  :rerdoc => "rdoc:force")
+#
+# This will create the tasks <tt>:rdoc</tt>, <tt>:rdoc_clean</tt> and
+# <tt>:rdoc:force</tt>.
+
+class RDoc::Task < Rake::TaskLib
+
+  ##
+  # Name of the main, top level task.  (default is :rdoc)
+
+  attr_accessor :name
+
+  ##
+  # Name of directory to receive the html output files. (default is "html")
+
+  attr_accessor :rdoc_dir
+
+  ##
+  # Title of RDoc documentation. (defaults to rdoc's default)
+
+  attr_accessor :title
+
+  ##
+  # Name of file to be used as the main, top level file of the RDoc. (default
+  # is none)
+
+  attr_accessor :main
+
+  ##
+  # Name of template to be used by rdoc. (defaults to rdoc's default)
+
+  attr_accessor :template
+
+  ##
+  # List of files to be included in the rdoc generation. (default is [])
+
+  attr_accessor :rdoc_files
+
+  ##
+  # Additional list of options to be passed rdoc.  (default is [])
+
+  attr_accessor :options
+
+  ##
+  # Whether to run the rdoc process as an external shell (default is false)
+
+  attr_accessor :external
+
+  ##
+  # Create an RDoc task with the given name. See the RDoc::Task class overview
+  # for documentation.
+
+  def initialize(name = :rdoc)  # :yield: self
+    if name.is_a? Hash then
+      invalid_options = name.keys.map { |k| k.to_sym } -
+        [:rdoc, :clobber_rdoc, :rerdoc]
+
+      unless invalid_options.empty? then
+        raise ArgumentError, "invalid options: #{invalid_options.join(", ")}"
+      end
+    end
+
+    @name = name
+    @rdoc_files = Rake::FileList.new
+    @rdoc_dir = 'html'
+    @main = nil
+    @title = nil
+    @template = nil
+    @external = false
+    @options = []
+    yield self if block_given?
+    define
+  end
+
+  ##
+  # Create the tasks defined by this task lib.
+
+  def define
+    if rdoc_task_name != "rdoc" then
+      desc "Build the RDoc HTML Files"
+    else
+      desc "Build the #{rdoc_task_name} HTML Files"
+    end
+    task rdoc_task_name
+
+    desc "Force a rebuild of the RDoc files"
+    task rerdoc_task_name => [clobber_task_name, rdoc_task_name]
+
+    desc "Remove RDoc products"
+    task clobber_task_name do
+      rm_r rdoc_dir rescue nil
+    end
+
+    task :clobber => [clobber_task_name]
+
+    directory @rdoc_dir
+    task rdoc_task_name => [rdoc_target]
+    file rdoc_target => @rdoc_files + [Rake.application.rakefile] do
+      rm_r @rdoc_dir rescue nil
+      @before_running_rdoc.call if @before_running_rdoc
+      args = option_list + @rdoc_files
+
+      if @external then
+        argstring = args.join(' ')
+        sh %{ruby -Ivendor vendor/rd #{argstring}}
+      else
+        if Rake.application.options.trace then
+          $stderr.puts "rdoc #{args.join ' '}"
+        end
+        require 'rdoc/rdoc'
+        RDoc::RDoc.new.document(args)
+      end
+    end
+
+    self
+  end
+
+  def option_list
+    result = @options.dup
+    result << "-o" << @rdoc_dir
+    result << "--main" << quote(main) if main
+    result << "--title" << quote(title) if title
+    result << "-T" << quote(template) if template
+    result
+  end
+
+  def quote(str)
+    if @external
+      "'#{str}'"
+    else
+      str
+    end
+  end
+
+  def option_string
+    option_list.join(' ')
+  end
+
+  ##
+  # The block passed to this method will be called just before running the
+  # RDoc generator. It is allowed to modify RDoc::Task attributes inside the
+  # block.
+
+  def before_running_rdoc(&block)
+    @before_running_rdoc = block
+  end
+
+  private
+
+  def rdoc_target
+    "#{rdoc_dir}/index.html"
+  end
+
+  def rdoc_task_name
+    case name
+    when Hash
+      (name[:rdoc] || "rdoc").to_s
+    else
+      name.to_s
+    end
+  end
+
+  def clobber_task_name
+    case name
+    when Hash
+      (name[:clobber_rdoc] || "clobber_rdoc").to_s
+    else
+      "clobber_#{name}"
+    end
+  end
+
+  def rerdoc_task_name
+    case name
+    when Hash
+      (name[:rerdoc] || "rerdoc").to_s
+    else
+      "re#{name}"
+    end
+  end
+
+end
+
+# :stopdoc:
+module Rake
+
+  ##
+  # For backwards compatibility
+
+  RDocTask = RDoc::Task
+
+end
+# :startdoc:
+

data/lib/rdoc/top_level.rb

@@ -147,6 +147,16 @@ class RDoc::TopLevel < RDoc::Context
     end
   end
 
+  ##
+  # Adds +method+ to Object instead of RDoc::TopLevel
+
+  def add_method(method)
+    object = self.class.find_class_named 'Object'
+    object = add_class RDoc::NormalClass, 'Object' unless object
+
+    object.add_method method
+  end
+
   ##
   # Base name of this file
 

data/test/test_rdoc_markup_attribute_manager.rb

@@ -124,6 +124,10 @@ class TestRDocMarkupAttributeManager < MiniTest::Unit::TestCase
                  @am.flow("*\\bold*")
   end
 
+  def test_bold_html_escaped
+    assert_equal ['cat <b>dog</b>'], @am.flow('cat \<b>dog</b>')
+  end
+
   def test_combined
     assert_equal(["cat ", @em_on, "and", @em_off, " ", @bold_on, "dog", @bold_off],
                   @am.flow("cat _and_ *dog*"))
@@ -229,6 +233,11 @@ class TestRDocMarkupAttributeManager < MiniTest::Unit::TestCase
     assert_equal(["cats' ", crossref("#fred")].flatten, @am.flow("cats' #fred"))
   end
 
+  def test_tt_html
+    assert_equal [@tt_on, '"\n"', @tt_off],
+                 @am.flow('<tt>"\n"</tt>')
+  end
+
 end
 
 MiniTest::Unit.autorun

data/test/test_rdoc_markup_to_html.rb

@@ -48,6 +48,7 @@ class TestRDocMarkupToHtml < MiniTest::Unit::TestCase
   def test_tt_formatting
     assert_equal "<p>\n<tt>--</tt> &#8212; <tt>cats'</tt> cats&#8217;\n</p>\n",
                  util_format("<tt>--</tt> -- <tt>cats'</tt> cats'")
+
     assert_equal "<p>\n<b>&#8212;</b>\n</p>\n", util_format("<b>--</b>")
   end
 

data/test/test_rdoc_markup_to_html_crossref.rb

@@ -136,6 +136,7 @@ class TestRDocMarkupToHtmlCrossref < XrefTestCase
 
     refute_ref 'bogus', 'bogus'
     refute_ref 'bogus', '\bogus'
+    refute_ref '\bogus', '\\\bogus'
 
     refute_ref '#n',    '\#n'
     refute_ref '#n()',  '\#n()'

data/test/test_rdoc_parser_c.rb

@@ -358,6 +358,34 @@ Init_IO(void) {
     assert_equal "  Method Comment!   \n", read_method.comment
   end
 
+  def test_define_method_private
+    content = <<-EOF
+/*Method Comment! */
+static VALUE
+rb_io_s_read(argc, argv, io)
+    int argc;
+    VALUE *argv;
+    VALUE io;
+{
+}
+
+void
+Init_IO(void) {
+    /*
+     * a comment for class Foo on rb_define_class
+     */
+    VALUE rb_cIO = rb_define_class("IO", rb_cObject);
+    rb_define_private_method(rb_cIO, "read", rb_io_s_read, -1);
+}
+    EOF
+
+    klass = util_get_class content, 'rb_cIO'
+    read_method = klass.method_list.first
+    assert_equal 'IO#read', read_method.full_name
+    assert_equal :private, read_method.visibility
+    assert_equal "  Method Comment!   \n", read_method.comment
+  end
+
   def util_get_class(content, name)
     @parser = util_parser content
     @parser.scan

data/test/test_rdoc_parser_ruby.rb

@@ -1,7 +1,7 @@
 require 'stringio'
 require 'tempfile'
 require 'rubygems'
-require 'minitest/unit'
+require 'minitest/autorun'
 
 require 'rdoc/options'
 require 'rdoc/parser/ruby'
@@ -697,6 +697,95 @@ EOF
     assert klass.method_list.empty?
   end
 
+  def test_parse_method_no_parens
+    klass = RDoc::NormalClass.new 'Foo'
+    klass.parent = @top_level
+
+    comment = "##\n# my method\n"
+
+    util_parser "def foo arg1, arg2\nend"
+
+    tk = @parser.get_tk
+
+    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, comment
+
+    foo = klass.method_list.first
+    assert_equal '(arg1, arg2)', foo.params
+  end
+
+  def test_parse_method_parameters_comment
+    klass = RDoc::NormalClass.new 'Foo'
+    klass.parent = @top_level
+
+    comment = "##\n# my method\n"
+
+    util_parser "def foo arg1, arg2 # some useful comment\nend"
+
+    tk = @parser.get_tk
+
+    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, comment
+
+    foo = klass.method_list.first
+    assert_equal '(arg1, arg2)', foo.params
+  end
+
+  def test_parse_method_parameters_comment_continue
+    klass = RDoc::NormalClass.new 'Foo'
+    klass.parent = @top_level
+
+    comment = "##\n# my method\n"
+
+    util_parser "def foo arg1, arg2, # some useful comment\narg3\nend"
+
+    tk = @parser.get_tk
+
+    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, comment
+
+    foo = klass.method_list.first
+    assert_equal '(arg1, arg2, arg3)', foo.params
+  end
+
+  def test_parse_method_toplevel
+    klass = @top_level
+
+    comment = "##\n# my method\n"
+
+    util_parser "def foo arg1, arg2\nend"
+
+    tk = @parser.get_tk
+
+    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, comment
+
+    object = RDoc::TopLevel.find_class_named 'Object'
+
+    foo = object.method_list.first
+    assert_equal 'Object#foo', foo.full_name
+  end
+
+  def test_parse_statements_class_if
+    comment = "##\n# my method\n"
+
+    util_parser <<-CODE
+module Foo
+  X = if TRUE then
+        ''
+      end
+
+  def blah
+  end
+end
+    CODE
+
+    @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL, nil, ''
+
+    foo = @top_level.modules.first
+    assert_equal 'Foo', foo.full_name, 'module Foo'
+
+    methods = foo.method_list
+    assert_equal 1, methods.length
+    assert_equal 'Foo#blah', methods.first.full_name
+  end
+
   def test_parse_statements_class_nested
     comment = "##\n# my method\n"
 
@@ -949,4 +1038,3 @@ EOF
 
 end
 
-MiniTest::Unit.autorun