rdoc 2.5.11 → 3.0

data/test/test_rdoc_top_level.rb

@@ -27,6 +27,17 @@ class TestRDocTopLevel < XrefTestCase
     assert_equal expected, RDoc::TopLevel.classes.map { |m| m.full_name }.sort
   end
 
+  def test_class_complete
+    @c2.add_module_alias @c2_c3, 'A1'
+
+    RDoc::TopLevel.complete :public
+
+    a1 = @xref_data.find_class_or_module 'C2::A1'
+
+    assert_equal 'C2::A1', a1.full_name
+    refute_empty a1.aliases
+  end
+
   def test_class_files
     assert_equal %w[path/top_level.rb xref_data.rb],
                  RDoc::TopLevel.files.map { |m| m.full_name }.sort
@@ -94,13 +105,11 @@ class TestRDocTopLevel < XrefTestCase
   end
 
   def test_last_modified
-    assert_equal 'Unknown', @top_level.last_modified
-
+    assert_equal nil, @top_level.last_modified
     stat = Object.new
     def stat.mtime() 0 end
     @top_level.file_stat = stat
-
-    assert_equal '0', @top_level.last_modified
+    assert_equal 0, @top_level.last_modified
   end
 
   def test_name

data/test/xref_data.rb

@@ -13,9 +13,15 @@ class C1
 
   def m foo
   end
+
 end
 
 class C2
+  def b
+  end
+
+  alias a b
+
   class C3
     def m
     end
@@ -46,6 +52,8 @@ class C5
 end
 
 module M1
+  def m
+  end
 end
 
 module M1::M2

data/test/xref_test_case.rb

@@ -38,7 +38,11 @@ class XrefTestCase < MiniTest::Unit::TestCase
     @c1_m  = @c1.method_list.last  # C1#m
     @c1__m = @c1.method_list.first # C1::m
 
+
     @c2    = @xref_data.find_module_named 'C2'
+    @c2_a  = @c2.method_list.last
+    @c2_b  = @c2.method_list.first
+
     @c2_c3 = @xref_data.find_module_named 'C2::C3'
     @c3    = @xref_data.find_module_named 'C3'
     @c4    = @xref_data.find_module_named 'C4'
@@ -48,6 +52,8 @@ class XrefTestCase < MiniTest::Unit::TestCase
     @c3_h2 = @xref_data.find_module_named 'C3::H2'
 
     @m1    = @xref_data.find_module_named 'M1'
+    @m1_m  = @m1.method_list.first
+
     @m1_m2 = @xref_data.find_module_named 'M1::M2'
   end
 

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rdoc
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 7
   prerelease: false
   segments: 
-  - 2
-  - 5
-  - 11
-  version: 2.5.11
+  - 3
+  - 0
+  version: "3.0"
 platform: ruby
 authors: 
 - Eric Hodel
@@ -39,7 +38,7 @@ cert_chain:
   x52qPcexcYZR7w==
   -----END CERTIFICATE-----
 
-date: 2010-08-20 00:00:00 -07:00
+date: 2010-12-19 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -66,11 +65,10 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 9
+        hash: 7
         segments: 
-        - 1
-        - 3
-        version: "1.3"
+        - 2
+        version: "2"
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -81,12 +79,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 21
+        hash: 19
         segments: 
         - 2
-        - 6
-        - 1
-        version: 2.6.1
+        - 7
+        - 0
+        version: 2.7.0
   type: :development
   version_requirements: *id003
 description: |-
@@ -137,6 +135,8 @@ files:
 - lib/rdoc/code_objects.rb
 - lib/rdoc/constant.rb
 - lib/rdoc/context.rb
+- lib/rdoc/encoding.rb
+- lib/rdoc/erbio.rb
 - lib/rdoc/gauntlet.rb
 - lib/rdoc/generator.rb
 - lib/rdoc/generator/darkfish.rb
@@ -186,9 +186,10 @@ files:
 - lib/rdoc/markup/list_item.rb
 - lib/rdoc/markup/paragraph.rb
 - lib/rdoc/markup/parser.rb
-- lib/rdoc/markup/preprocess.rb
+- lib/rdoc/markup/pre_process.rb
 - lib/rdoc/markup/raw.rb
 - lib/rdoc/markup/rule.rb
+- lib/rdoc/markup/text_formatter_test_case.rb
 - lib/rdoc/markup/to_ansi.rb
 - lib/rdoc/markup/to_bs.rb
 - lib/rdoc/markup/to_html.rb
@@ -197,12 +198,12 @@ files:
 - lib/rdoc/markup/to_test.rb
 - lib/rdoc/markup/verbatim.rb
 - lib/rdoc/meta_method.rb
+- lib/rdoc/method_attr.rb
 - lib/rdoc/normal_class.rb
 - lib/rdoc/normal_module.rb
 - lib/rdoc/options.rb
 - lib/rdoc/parser.rb
 - lib/rdoc/parser/c.rb
-- lib/rdoc/parser/perl.rb
 - lib/rdoc/parser/ruby.rb
 - lib/rdoc/parser/ruby_tools.rb
 - lib/rdoc/parser/simple.rb
@@ -217,9 +218,12 @@ files:
 - lib/rdoc/ruby_token.rb
 - lib/rdoc/single_class.rb
 - lib/rdoc/stats.rb
+- lib/rdoc/stats/normal.rb
+- lib/rdoc/stats/quiet.rb
+- lib/rdoc/stats/verbose.rb
 - lib/rdoc/task.rb
 - lib/rdoc/text.rb
-- lib/rdoc/tokenstream.rb
+- lib/rdoc/token_stream.rb
 - lib/rdoc/top_level.rb
 - test/README
 - test/binary.dat
@@ -228,12 +232,15 @@ files:
 - test/test.ja.txt
 - test/test.txt
 - test/test_attribute_manager.rb
+- test/test_rdoc_alias.rb
 - test/test_rdoc_any_method.rb
 - test/test_rdoc_attr.rb
 - test/test_rdoc_class_module.rb
 - test/test_rdoc_code_object.rb
 - test/test_rdoc_constant.rb
 - test/test_rdoc_context.rb
+- test/test_rdoc_encoding.rb
+- test/test_rdoc_generator_darkfish.rb
 - test/test_rdoc_generator_ri.rb
 - test/test_rdoc_include.rb
 - test/test_rdoc_markup.rb
@@ -248,12 +255,12 @@ files:
 - test/test_rdoc_markup_to_html.rb
 - test/test_rdoc_markup_to_html_crossref.rb
 - test/test_rdoc_markup_to_rdoc.rb
+- test/test_rdoc_method_attr.rb
 - test/test_rdoc_normal_class.rb
 - test/test_rdoc_normal_module.rb
 - test/test_rdoc_options.rb
 - test/test_rdoc_parser.rb
 - test/test_rdoc_parser_c.rb
-- test/test_rdoc_parser_perl.rb
 - test/test_rdoc_parser_ruby.rb
 - test/test_rdoc_parser_simple.rb
 - test/test_rdoc_rdoc.rb
@@ -321,12 +328,15 @@ specification_version: 3
 summary: RDoc is an application that produces documentation for one or more Ruby source files
 test_files: 
 - test/test_attribute_manager.rb
+- test/test_rdoc_alias.rb
 - test/test_rdoc_any_method.rb
 - test/test_rdoc_attr.rb
 - test/test_rdoc_class_module.rb
 - test/test_rdoc_code_object.rb
 - test/test_rdoc_constant.rb
 - test/test_rdoc_context.rb
+- test/test_rdoc_encoding.rb
+- test/test_rdoc_generator_darkfish.rb
 - test/test_rdoc_generator_ri.rb
 - test/test_rdoc_include.rb
 - test/test_rdoc_markup.rb
@@ -341,12 +351,12 @@ test_files:
 - test/test_rdoc_markup_to_html.rb
 - test/test_rdoc_markup_to_html_crossref.rb
 - test/test_rdoc_markup_to_rdoc.rb
+- test/test_rdoc_method_attr.rb
 - test/test_rdoc_normal_class.rb
 - test/test_rdoc_normal_module.rb
 - test/test_rdoc_options.rb
 - test/test_rdoc_parser.rb
 - test/test_rdoc_parser_c.rb
-- test/test_rdoc_parser_perl.rb
 - test/test_rdoc_parser_ruby.rb
 - test/test_rdoc_parser_simple.rb
 - test/test_rdoc_rdoc.rb

data/lib/rdoc/parser/perl.rb

@@ -1,165 +0,0 @@
-require 'rdoc/parser'
-
-##
-#
-# This is an attamept to write a basic parser for Perl's
-# POD (Plain old Documentation) format.  Ruby code must
-# co-exist with Perl, and some tasks are easier in Perl
-# than Ruby because of existing libraries.
-#
-# One difficult is that Perl POD has no means of identifying
-# the classes (packages) and methods (subs) with which it
-# is associated, it is more like literate programming in so
-# far as it just happens to be in the same place as the code,
-# but need not be.
-#
-# 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.
-#
-
-class RDoc::Parser::PerlPOD < RDoc::Parser
-
-  parse_files_matching(/.p[lm]$/)
-
-  ##
-  # Prepare to parse a perl file
-
-  def initialize(top_level, file_name, content, options, stats)
-    super
-
-    preprocess = RDoc::Markup::PreProcess.new @file_name, @options.rdoc_include
-
-    preprocess.handle @content do |directive, param|
-      warn "Unrecognized directive '#{directive}' in #{@file_name}"
-    end
-  end
-
-  ##
-  # Extract the Pod(-like) comments from the code.
-  # At its most basic there will ne no need to distinguish
-  # between the different types of header, etc.
-  #
-  # This uses a simple finite state machine, in a very
-  # procedural pattern. I could "replace case with polymorphism"
-  # 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,
-  # and preserving state about what is seen is necesary.
-
-  def scan
-
-    @top_level.comment ||= ""
-    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
-      if line =~ /^\s+$/
-	state = :code_blank
-      end
-    end
-
-    pod_noop = lambda do
-      if line =~ /^\s+$/
-	state = :pod_blank
-      end
-      @top_level.comment += filter(line)
-    end
-
-    begin_noop = lambda do
-      if line =~ /^\s+$/
-	state = :begin_blank
-      end
-      @top_level.comment += filter(line)
-    end
-
-    # Now for the blocks that process code and comments...
-
-    transit_to_pod = lambda do
-      case line
-      when /^=(?:pod|head\d+)/
-	state = :pod_no_blank
-	@top_level.comment += filter(line)
-      when /^=over/
-	state = :over_no_blank
-	@top_level.comment += filter(line)
-      when /^=(?:begin|for)/
-	state = :begin_no_blank
-      end
-    end
-
-    process_pod = lambda do
-      case line
-      when  /^\s*$/
-	state = :pod_blank
-	@top_level.comment += filter(line)
-      when /^=cut/
-	state = :code_no_blank
-      when /^=end/
-	$stderr.puts "'=end' unexpected at #{line_number} in #{@file_name}"
-      else
-	@top_level.comment += filter(line)
-      end
-    end
-
-
-    process_begin = lambda do
-      case line
-      when  /^\s*$/
-	state = :begin_blank
-	@top_level.comment += filter(line)
-      when /^=end/
-	state = :code_no_blank
-      when /^=cut/
-	$stderr.puts "'=cut' unexpected at #{line_number} in #{@file_name}"
-      else
-	@top_level.comment += filter(line)
-      end
-
-    end
-
-
-    transitions = { :code_no_blank => code_noop,
-                    :code_blank => transit_to_pod,
-		    :pod_no_blank => pod_noop,
-		    :pod_blank => process_pod,
-		    :begin_no_blank => begin_noop,
-		    :begin_blank => process_begin}
-    @content.each_line do |l|
-      line = l
-      line_number += 1
-      transitions[state].call
-    end # each line
-
-    @top_level
-  end
-
-  # Filter the perl markup that does the same as the rdoc
-  # filtering.  Only basic for now. Will probably need a
-  # proper parser to cope with C<<...>> etc
-  def filter(comment)
-    return '' if comment =~ /^=pod\s*$/
-    comment.gsub!(/^=pod/, '==')
-    comment.gsub!(/^=head(\d+)/) do
-      "=" * $1.to_i
-    end
-    comment.gsub!(/=item/, '');
-    comment.gsub!(/C<(.*?)>/, '<tt>\1</tt>');
-    comment.gsub!(/I<(.*?)>/, '<i>\1</i>');
-    comment.gsub!(/B<(.*?)>/, '<b>\1</b>');
-    comment
-  end
-
-end
-

data/test/test_rdoc_parser_perl.rb

@@ -1,73 +0,0 @@
-require 'stringio'
-require 'tempfile'
-require 'rubygems'
-require 'minitest/autorun'
-require 'rdoc/options'
-require 'rdoc/parser/perl'
-
-class TestRdocParserPerlPOD < MiniTest::Unit::TestCase
-
-  def setup
-    @tempfile = Tempfile.new self.class.name
-    filename = @tempfile.path
-
-    @top_level = RDoc::TopLevel.new filename
-    @fn = filename
-    @options = RDoc::Options.new
-    @stats = RDoc::Stats.new 0
-  end
-
-  def teardown
-    @tempfile.close
-  end
-
-  def test_uncommented_perl
-    content = <<-EOF
-while (<>) {
-  tr/a-z/A-Z;
-  print
-}
-    EOF
-
-    comment =  util_get_comment content
-    assert_equal "", comment
-  end
-
-  def test_perl_without_pod
-    content = <<-EOF
-#!/usr/local/bin/perl
-#
-#This is a pointless perl program because it does -p.
-#
-while(<>) {print;}:
-    EOF
-
-    comment = util_get_comment content
-    assert_equal "", comment
-  end
-
-  def test_simple_pod_no_structure
-    content = <<-EOF
-=begin pod
-
-This just contains plain old documentation
-
-=end
-    EOF
-    comment = util_get_comment content
-    assert_equal 'This just contains plain old documentation', comment
-  end
-
-  # Get the comment of the @top_level when it has processed the input.
-  def util_get_comment(content)
-    parser = util_parser content
-    parser.scan.comment
-  end
-
-  # create a new parser with the supplied content.
-  def util_parser(content)
-    RDoc::Parser::PerlPOD.new @top_level, @fn, content, @options, @stats
-  end
-
-end
-