rdoc 3.10.pre.3 → 3.10

data/lib/rdoc/parser/ruby.rb

@@ -1801,12 +1801,10 @@ class RDoc::Parser::Ruby < RDoc::Parser
   end
 
   ##
-  # Prints +msg+ to +$stderr+ unless we're being quiet
+  # Prints +message+ to +$stderr+ unless we're being quiet
 
-  def warn(msg)
-    return if @options.quiet
-    msg = make_message msg
-    $stderr.puts msg
+  def warn message
+    @options.warn make_message message
   end
 
 end

data/lib/rdoc/rdoc.rb

@@ -37,6 +37,11 @@ require 'time'
 
 class RDoc::RDoc
 
+  ##
+  # This is the list of supported output generators
+
+  GENERATORS = {}
+
   ##
   # File pattern to exclude
 
@@ -62,11 +67,6 @@ class RDoc::RDoc
 
   attr_reader :stats
 
-  ##
-  # This is the list of supported output generators
-
-  GENERATORS = {}
-
   ##
   # Add +klass+ that can generate output after parsing
 
@@ -155,6 +155,33 @@ class RDoc::RDoc
     end
   end
 
+  ##
+  # Loads options from .rdoc_options if the file exists, otherwise creates a
+  # new RDoc::Options instance.
+
+  def load_options
+    options_file = File.expand_path '.rdoc_options'
+    return RDoc::Options.new unless File.exist? options_file
+
+    RDoc.load_yaml
+
+    parse_error = if Object.const_defined? :Psych then
+                    Psych::SyntaxError
+                  else
+                    ArgumentError
+                  end
+
+    begin
+      options = YAML.load_file '.rdoc_options'
+    rescue *parse_error
+    end
+
+    raise RDoc::Error, "#{options_file} is not a valid rdoc options file" unless
+      RDoc::Options === options
+
+    options
+  end
+
   ##
   # Create an output dir if it doesn't exist. If it does exist, but doesn't
   # contain the flag file <tt>created.rid</tt> then we refuse to use it, as
@@ -405,7 +432,7 @@ The internal error was:
       @options = options
       @options.finish
     else
-      @options = RDoc::Options.new
+      @options = load_options
       @options.parse options
     end
 

data/lib/rdoc/ruby_lex.rb

@@ -55,7 +55,7 @@ class RDoc::RubyLex
   end
 
   self.debug_level = 0
-  
+
   # :startdoc:
 
   ##
@@ -69,7 +69,7 @@ class RDoc::RubyLex
     scanner.exception_on_syntax_error = true
 
     while token = scanner.token do
-      tokens << token 
+      tokens << token
     end
 
     tokens
@@ -960,7 +960,8 @@ class RDoc::RubyLex
       if peek(0) == '='
         token.concat getc
       end
-    elsif @lex_state == EXPR_BEG || @lex_state == EXPR_DOT
+    elsif @lex_state == EXPR_BEG || @lex_state == EXPR_DOT ||
+          @lex_state == EXPR_ARG
       @lex_state = EXPR_ARG
     else
       @lex_state = EXPR_END

data/lib/rdoc/test_case.rb

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'minitest/autorun'
+require 'minitest/benchmark' if ENV['BENCHMARK']
 
 require 'fileutils'
 require 'pp'
@@ -48,6 +49,22 @@ class RDoc::TestCase < MiniTest::Unit::TestCase
     RDoc::Comment.new text, top_level
   end
 
+  ##
+  # Creates a temporary directory changes the current directory to it for the
+  # duration of the block.
+  #
+  # Depends upon Dir.mktmpdir
+
+  def temp_dir
+    skip "No Dir::mktmpdir, upgrade your ruby" unless Dir.respond_to? :mktmpdir
+
+    Dir.mktmpdir do |temp_dir|
+      Dir.chdir temp_dir do
+        yield temp_dir
+      end
+    end
+  end
+
 end
 
 # This hack allows autoload to work when Dir.pwd is changed for Ruby 1.8 since

data/lib/rdoc/top_level.rb

@@ -378,6 +378,14 @@ class RDoc::TopLevel < RDoc::Context
 
   alias name base_name
 
+  ##
+  # Only a TopLevel that contains text file) will be displayed.  See also
+  # RDoc::CodeObject#display?
+
+  def display?
+    text? and super
+  end
+
   ##
   # See RDoc::TopLevel::find_class_or_module
   #--

data/test/test_rdoc_any_method.rb

@@ -176,6 +176,15 @@ method(a, b) { |c, d| ... }
     assert_equal %w[a b c d], m.param_list
   end
 
+  def test_param_list_default
+    m = RDoc::AnyMethod.new nil, 'method'
+    m.parent = @c1
+
+    m.params = '(b = default)'
+
+    assert_equal %w[b], m.param_list
+  end
+
   def test_param_list_params
     m = RDoc::AnyMethod.new nil, 'method'
     m.parent = @c1

data/test/test_rdoc_attr.rb

@@ -65,6 +65,16 @@ class TestRDocAttr < RDoc::TestCase
     assert_equal 'RW',         loaded.rw
     assert_equal false,        loaded.singleton
     assert_equal :public,      loaded.visibility
+  end
+
+  def test_marshal_dump_singleton
+    tl = RDoc::TopLevel.new 'file.rb'
+
+    @a.comment = 'this is a comment'
+    @a.record_location tl
+
+    cm = RDoc::ClassModule.new 'Klass'
+    cm.add_attribute @a
 
     @a.rw = 'R'
     @a.singleton = true
@@ -74,6 +84,9 @@ class TestRDocAttr < RDoc::TestCase
 
     assert_equal @a, loaded
 
+    comment = RDoc::Markup::Document.new(
+                RDoc::Markup::Paragraph.new('this is a comment'))
+
     assert_equal comment,       loaded.comment
     assert_equal 'Klass::attr', loaded.full_name
     assert_equal 'attr',        loaded.name

data/test/test_rdoc_class_module.rb

@@ -774,6 +774,19 @@ class TestRDocClassModule < XrefTestCase
     assert_equal [a, c], @c1.includes
   end
 
+  def test_update_includes_trim
+    a = RDoc::Include.new 'D::M', nil
+    b = RDoc::Include.new 'D::M', nil
+
+    @c1.add_include a
+    @c1.add_include b
+    @c1.ancestors # cache included modules
+
+    @c1.update_includes
+
+    assert_equal [a], @c1.includes
+  end
+
   def test_update_includes_with_colons
     a = RDoc::Include.new 'M1', nil
     b = RDoc::Include.new 'M1::M2', nil

data/test/test_rdoc_context.rb

@@ -183,16 +183,6 @@ class TestRDocContext < XrefTestCase
     assert_equal [incl], @context.includes
   end
 
-  def test_add_include_twice
-    incl1 = RDoc::Include.new 'Name', 'comment'
-    @context.add_include incl1
-
-    incl2 = RDoc::Include.new 'Name', 'comment'
-    @context.add_include incl2
-
-    assert_equal [incl1], @context.includes
-  end
-
   def test_add_method
     meth = RDoc::AnyMethod.new nil, 'old_name'
     meth.visibility = nil
@@ -334,6 +324,16 @@ class TestRDocContext < XrefTestCase
     refute_includes arr, incl
   end
 
+  def bench_add_include
+    cm = RDoc::ClassModule.new 'Klass'
+
+    assert_performance_linear 0.9 do |count|
+      count.times do |i|
+        cm.add_include RDoc::Include.new("N::M#{i}", nil)
+      end
+    end
+  end
+
   def test_child_name
     assert_equal 'C1::C1', @c1.child_name('C1')
   end

data/test/test_rdoc_cross_reference.rb

@@ -16,13 +16,6 @@ class TestRDocCrossReference < XrefTestCase
     assert_equal name, @xref.resolve(name, name)
   end
 
-  def test_resolve_page
-    page = RDoc::TopLevel.new 'README.txt'
-    page.parser = RDoc::Parser::Simple
-
-    assert_ref page, 'README'
-  end
-
   def test_resolve_C2
     @xref = RDoc::CrossReference.new @c2
 
@@ -100,7 +93,7 @@ class TestRDocCrossReference < XrefTestCase
   end
 
   def test_resolve_file
-    assert_ref @xref_data, 'xref_data.rb'
+    refute_ref 'xref_data.rb'
   end
 
   def test_resolve_method
@@ -136,6 +129,13 @@ class TestRDocCrossReference < XrefTestCase
     assert_ref @c2_c3_m, '::C2::C3#m(*)'
   end
 
+  def test_resolve_page
+    page = RDoc::TopLevel.new 'README.txt'
+    page.parser = RDoc::Parser::Simple
+
+    assert_ref page, 'README'
+  end
+
   def test_resolve_percent
     i_percent = RDoc::AnyMethod.new nil, '%'
     i_percent.singleton = false

data/test/test_rdoc_markup_parser.rb

@@ -441,6 +441,17 @@ a. 新しい機能
     assert_equal expected, @RMP.parse(str).parts
   end
 
+  def test_parse_line_break
+    str = "now is\nthe time  \nfor all"
+
+    expected = [
+      @RM::Paragraph.new('now is', 'the time'),
+      @RM::BlankLine.new,
+      @RM::Paragraph.new('for all')]
+
+    assert_equal expected, @RMP.parse(str).parts
+  end
+
   def test_parse_list_list_1
     str = <<-STR
 10. para 1
@@ -1233,6 +1244,53 @@ b. l1.1
     assert_equal expected, @RMP.tokenize(str)
   end
 
+  def test_tokenize_line_break
+    str = "now is\nthe time  \nfor all\n"
+
+    expected = [
+      [:TEXT,    'now is',    0, 0],
+      [:NEWLINE, "\n",        6, 0],
+      [:TEXT,    'the time',  0, 1],
+      [:BREAK,   "  ",        8, 1],
+      [:NEWLINE, "\n",       10, 1],
+      [:TEXT,    'for all',   0, 2],
+      [:NEWLINE, "\n",        7, 2],
+    ]
+
+    assert_equal expected, @RMP.tokenize(str)
+  end
+
+  def test_tokenize_line_break_long
+    str = "now is\nthe time   \nfor all\n"
+
+    expected = [
+      [:TEXT,    'now is',     0, 0],
+      [:NEWLINE, "\n",         6, 0],
+      [:TEXT,    'the time ',  0, 1],
+      [:BREAK,   '  ',         9, 1],
+      [:NEWLINE, "\n",        11, 1],
+      [:TEXT,    'for all',    0, 2],
+      [:NEWLINE, "\n",         7, 2],
+    ]
+
+    assert_equal expected, @RMP.tokenize(str)
+  end
+
+  def test_tokenize_line_break_no_short
+    str = "now is\nthe time \nfor all\n"
+
+    expected = [
+      [:TEXT,    'now is',    0, 0],
+      [:NEWLINE, "\n",        6, 0],
+      [:TEXT,    'the time ', 0, 1],
+      [:NEWLINE, "\n",        9, 1],
+      [:TEXT,    'for all',   0, 2],
+      [:NEWLINE, "\n",        7, 2],
+    ]
+
+    assert_equal expected, @RMP.tokenize(str)
+  end
+
   def test_tokenize_note
     str = <<-STR
 cat:: l1

data/test/test_rdoc_markup_to_html_crossref.rb

@@ -43,7 +43,7 @@ class TestRDocMarkupToHtmlCrossref < XrefTestCase
   def test_convert_RDOCLINK_rdoc_ref_method
     result = @to.convert 'rdoc-ref:C1#m'
 
-    assert_equal para("<a href=\"C1.html#method-i-m\">C1#m</a>"), result
+    assert_equal para("<a href=\"C1.html#method-i-m\">#m</a>"), result
   end
 
   def test_convert_RDOCLINK_rdoc_ref_method_label
@@ -59,14 +59,13 @@ class TestRDocMarkupToHtmlCrossref < XrefTestCase
 
     result = @to.convert 'rdoc-ref:C1#%'
 
-    assert_equal para("<a href=\"C1.html#method-i-25\">C1#%</a>"), result
+    assert_equal para("<a href=\"C1.html#method-i-25\">#%</a>"), result
 
     m.singleton = true
 
     result = @to.convert 'rdoc-ref:C1::%'
 
-    assert_equal para("<a href=\"C1.html#method-c-25\">C1::%</a>"), result
-
+    assert_equal para("<a href=\"C1.html#method-c-25\">::%</a>"), result
   end
 
   def test_convert_RDOCLINK_rdoc_ref_method_percent_label
@@ -113,12 +112,14 @@ class TestRDocMarkupToHtmlCrossref < XrefTestCase
   def test_handle_special_CROSSREF_show_hash_false
     @to.show_hash = false
 
-    assert_equal "<a href=\"C1.html#method-i-m\">m</a>",
+    assert_equal "<a href=\"C1.html#method-i-m\">#m</a>",
                  SPECIAL('#m')
   end
 
   def test_handle_special_HYPERLINK_rdoc
-    RDoc::TopLevel.new 'README.txt'
+    readme = RDoc::TopLevel.new 'README.txt'
+    readme.parser = RDoc::Parser::Simple
+
     @to = RDoc::Markup::ToHtmlCrossref.new 'C2.html', @c2, true
 
     link = @to.handle_special_HYPERLINK hyper 'C2::C3'
@@ -135,7 +136,9 @@ class TestRDocMarkupToHtmlCrossref < XrefTestCase
   end
 
   def test_handle_special_TIDYLINK_rdoc
-    RDoc::TopLevel.new 'README.txt'
+    readme = RDoc::TopLevel.new 'README.txt'
+    readme.parser = RDoc::Parser::Simple
+
     @to = RDoc::Markup::ToHtmlCrossref.new 'C2.html', @c2, true
 
     link = @to.handle_special_TIDYLINK tidy 'C2::C3'
@@ -161,7 +164,12 @@ class TestRDocMarkupToHtmlCrossref < XrefTestCase
   def test_link
     assert_equal 'n', @to.link('n', 'n')
 
-    assert_equal '<a href="C1.html#method-c-m">m</a>', @to.link('m', 'm')
+    assert_equal '<a href="C1.html#method-c-m">::m</a>', @to.link('m', 'm')
+  end
+
+  def test_link_class_method_full
+    assert_equal '<a href="Parent.html#method-c-m">Parent.m</a>',
+                 @to.link('Parent::m', 'Parent::m')
   end
 
   def para text

data/test/test_rdoc_method_attr.rb

@@ -111,6 +111,19 @@ class TestRDocMethodAttr < XrefTestCase
     assert_nil @m1_m.find_method_or_attribute 'm'
   end
 
+  def test_full_name
+    assert_equal 'C1#m',  @c1_m.full_name
+    assert_equal 'C1::m', @c1__m.full_name
+  end
+
+  def test_output_name
+    assert_equal '#m',  @c1_m.output_name(@c1)
+    assert_equal '::m', @c1__m.output_name(@c1)
+
+    assert_equal 'C1#m', @c1_m.output_name(@c2)
+    assert_equal 'C1.m', @c1__m.output_name(@c2)
+  end
+
   def test_search_record
     @c1_m.comment = 'This is a comment.'