ruby-changes:15494
From: drbrain <ko1@a...>
Date: Mon, 19 Apr 2010 14:10:03 +0900 (JST)
Subject: [ruby-changes:15494] Ruby:r27396 (trunk): Import RDoc 2.5.4
drbrain 2010-04-19 14:08:28 +0900 (Mon, 19 Apr 2010) New Revision: 27396 http://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=rev&revision=27396 Log: Import RDoc 2.5.4 Modified files: trunk/ChangeLog trunk/lib/rdoc/any_method.rb trunk/lib/rdoc/code_object.rb trunk/lib/rdoc/context.rb trunk/lib/rdoc/markup/to_html_crossref.rb trunk/lib/rdoc/parser/ruby.rb trunk/lib/rdoc/parser.rb trunk/lib/rdoc/rdoc.rb trunk/lib/rdoc.rb trunk/test/rdoc/test_rdoc_any_method.rb trunk/test/rdoc/test_rdoc_context.rb trunk/test/rdoc/test_rdoc_markup_to_html_crossref.rb trunk/test/rdoc/test_rdoc_parser_ruby.rb trunk/test/rdoc/xref_test_case.rb Index: ChangeLog =================================================================== --- ChangeLog (revision 27395) +++ ChangeLog (revision 27396) @@ -1,3 +1,7 @@ +Mon Apr 19 13:58:04 2010 Eric Hodel <drbrain@s...> + + * lib/rdoc: Update to RDoc 2.5.4. Fixes #3169, #3160, #3023. + Mon Apr 19 12:46:15 2010 Nobuyoshi Nakada <nobu@r...> * lib/timeout.rb (Timeout#timeout): propagate errors to the Index: lib/rdoc.rb =================================================================== --- lib/rdoc.rb (revision 27395) +++ lib/rdoc.rb (revision 27396) @@ -383,7 +383,7 @@ ## # RDoc version you are using - VERSION = '2.5.3' + VERSION = '2.5.4' ## # Name of the dotfile that contains the description of files to be processed Index: lib/rdoc/context.rb =================================================================== --- lib/rdoc/context.rb (revision 27395) +++ lib/rdoc/context.rb (revision 27396) @@ -511,6 +511,13 @@ end ## + # Finds a class method with +name+ in this context + + def find_class_method_named(name) + @method_list.find { |meth| meth.singleton && meth.name == name } + end + + ## # Finds a constant with +name+ in this context def find_constant_named(name) @@ -535,7 +542,7 @@ # Finds an instance method with +name+ in this context def find_instance_method_named(name) - @method_list.find { |meth| meth.name == name && !meth.singleton } + @method_list.find { |meth| !meth.singleton && meth.name == name } end ## @@ -554,7 +561,14 @@ # Finds a instance or module method with +name+ in this context def find_method_named(name) - @method_list.find { |meth| meth.name == name } + case name + when /\A#/ then + find_instance_method_named name[1..-1] + when /\A::/ then + find_class_method_named name[2..-1] + else + @method_list.find { |meth| meth.name == name } + end end ## @@ -575,7 +589,7 @@ result = nil case symbol - when /^::(.*)/ then + when /^::([A-Z].*)/ then result = top_level.find_symbol($1) when /::/ then modules = symbol.split(/::/) @@ -591,8 +605,9 @@ end end end + end - else + unless result then # if a method is specified, then we're definitely looking for # a module, otherwise it could be any symbol if method then @@ -610,10 +625,7 @@ end end - if result and method then - fail unless result.respond_to? :find_local_symbol - result = result.find_local_symbol(method) - end + result = result.find_local_symbol method if result and method result end Index: lib/rdoc/rdoc.rb =================================================================== --- lib/rdoc/rdoc.rb (revision 27395) +++ lib/rdoc/rdoc.rb (revision 27396) @@ -353,7 +353,6 @@ def document(argv) RDoc::TopLevel.reset RDoc::Parser::C.reset - RDoc::AnyMethod.reset @options = RDoc::Options.new @options.parse argv Index: lib/rdoc/parser.rb =================================================================== --- lib/rdoc/parser.rb (revision 27395) +++ lib/rdoc/parser.rb (revision 27396) @@ -75,8 +75,10 @@ false elsif s.scan(/<%|%>/).length >= 4 || s.index("\x00") then true - else + elsif 0.respond_to? :fdiv then s.count("^ -~\t\r\n").fdiv(s.size) > 0.3 + else # HACK 1.8.6 + (s.count("^ -~\t\r\n").to_f / s.size) > 0.3 end end Index: lib/rdoc/markup/to_html_crossref.rb =================================================================== --- lib/rdoc/markup/to_html_crossref.rb (revision 27395) +++ lib/rdoc/markup/to_html_crossref.rb (revision 27396) @@ -21,7 +21,7 @@ # # See CLASS_REGEXP_STR - METHOD_REGEXP_STR = '(\w+[!?=]?)(?:\([\w.+*/=<>-]*\))?' + METHOD_REGEXP_STR = '([a-z]\w*[!?=]?)(?:\([\w.+*/=<>-]*\))?' ## # Regular expressions matching text that should potentially have @@ -32,11 +32,14 @@ CROSSREF_REGEXP = /( # A::B::C.meth - #{CLASS_REGEXP_STR}[\.\#]#{METHOD_REGEXP_STR} + #{CLASS_REGEXP_STR}(?:[.#]|::)#{METHOD_REGEXP_STR} # Stand-alone method (proceeded by a #) | \\?\##{METHOD_REGEXP_STR} + # Stand-alone method (proceeded by ::) + | ::#{METHOD_REGEXP_STR} + # A::B::C # The stuff after CLASS_REGEXP_STR is a # nasty hack. CLASS_REGEXP_STR unfortunately matches @@ -86,11 +89,11 @@ end ## - # We're invoked when any text matches the CROSSREF pattern (defined in - # MarkUp). If we find the corresponding reference, generate a hyperlink. - # If the name we're looking for contains no punctuation, we look for it up - # the module/class chain. For example, HyperlinkHtml is found, even without - # the Generator:: prefix, because we look for it in module Generator first. + # We're invoked when any text matches the CROSSREF pattern. If we find the + # corresponding reference, generate a hyperlink. If the name we're looking + # for contains no punctuation, we look for it up the module/class chain. + # For example, HyperlinkHtml is found, even without the Generator:: prefix, + # because we look for it in module Generator first. def handle_special_CROSSREF(special) name = special.text @@ -102,13 +105,10 @@ return @seen[name] if @seen.include? name - if name[0, 1] == '#' then - lookup = name[1..-1] - name = lookup unless @show_hash - else - lookup = name - end + lookup = name + name = name[0, 1] unless @show_hash if name[0, 1] == '#' + # Find class, module, or method in class or module. # # Do not, however, use an if/elsif/else chain to do so. Instead, test @@ -119,9 +119,11 @@ # (in which case it would match the last pattern, which just checks # whether the string as a whole is a known symbol). - if /#{CLASS_REGEXP_STR}[\.\#]#{METHOD_REGEXP_STR}/ =~ lookup then + if /#{CLASS_REGEXP_STR}([.#]|::)#{METHOD_REGEXP_STR}/ =~ lookup then container = $1 - method = $2 + type = $2 + type = '#' if type == '.' + method = "#{type}#{$3}" ref = @context.find_symbol container, method end @@ -132,7 +134,7 @@ elsif lookup =~ /^\\/ then $' elsif ref and ref.document_self then - "<a href=\"#{ref.as_href(@from_path)}\">#{name}</a>" + "<a href=\"#{ref.as_href @from_path}\">#{name}</a>" else name end Index: lib/rdoc/code_object.rb =================================================================== --- lib/rdoc/code_object.rb (revision 27395) +++ lib/rdoc/code_object.rb (revision 27396) @@ -6,6 +6,24 @@ # # We contain the common stuff for contexts (which are containers) and other # elements (methods, attributes and so on) +# +# Here's the tree of the CodeObject subclasses: +# +# * RDoc::Context +# * RDoc::TopLevel +# * RDoc::ClassModule +# * RDoc::AnonClass +# * RDoc::NormalClass +# * RDoc::NormalModule +# * RDoc::SingleClass +# * RDoc::AnyMethod +# * RDoc::GhostMethod +# * RDoc::MetaMethod +# * RDoc::Alias +# * RDoc::Attr +# * RDoc::Constant +# * RDoc::Require +# * RDoc::Include class RDoc::CodeObject Index: lib/rdoc/any_method.rb =================================================================== --- lib/rdoc/any_method.rb (revision 27395) +++ lib/rdoc/any_method.rb (revision 27396) @@ -46,11 +46,6 @@ attr_reader :aliases ## - # Fragment reference for this method - - attr_reader :aref - - ## # The method we're aliasing attr_accessor :is_alias_for @@ -67,21 +62,13 @@ include RDoc::TokenStream - ## - # Resets method fragment reference counter - - def self.reset - @@aref = 'M000000' - end - - reset - def initialize(text, name) super() @text = text @name = name + @aref = nil @aliases = [] @block_params = nil @call_seq = nil @@ -92,9 +79,6 @@ @singleton = nil @token_stream = nil @visibility = :public - - @aref = @@aref - @@aref = @@aref.succ end ## @@ -112,6 +96,15 @@ end ## + # HTML fragment reference for this method + + def aref + type = singleton ? 'c' : 'i' + + "method-#{type}-#{CGI.escape name}" + end + + ## # The call_seq or the param_seq with method name, if there is no call_seq. # # Use this for displaying a method's argument lists. @@ -248,7 +241,7 @@ # Path to this method def path - "#{@parent.path}##{@aref}" + "#{@parent.path}##{aref}" end ## Index: lib/rdoc/parser/ruby.rb =================================================================== --- lib/rdoc/parser/ruby.rb (revision 27395) +++ lib/rdoc/parser/ruby.rb (revision 27396) @@ -1524,24 +1524,29 @@ skip_tkspace false tk = get_tk case tk - when TkLPAREN, TkfLPAREN + when TkLPAREN, TkfLPAREN then end_token = TkRPAREN else end_token = TkNL end + b_nest = 0 nest = 0 - @scanner.instance_eval{@continue = false} + @scanner.instance_eval { @continue = false } loop do case tk - when TkSEMICOLON - break - when TkLPAREN, TkfLPAREN + when TkSEMICOLON then + break if b_nest.zero? + when TkLPAREN, TkfLPAREN then nest += 1 + when TkBEGIN then + b_nest += 1 + when TkEND then + b_nest -= 1 when TkDO break if nest.zero? - when end_token + when end_token then if end_token == TkRPAREN nest -= 1 break if @scanner.lex_state == EXPR_END and nest.zero? @@ -1553,6 +1558,7 @@ end tk = get_tk end + skip_tkspace false get_tk if TkDO === peek_tk Index: test/rdoc/test_rdoc_context.rb =================================================================== --- test/rdoc/test_rdoc_context.rb (revision 27395) +++ test/rdoc/test_rdoc_context.rb (revision 27396) @@ -227,6 +227,14 @@ assert_equal 'RW', @c1.find_attribute_named('attr_accessor').rw end + def test_find_class_method_named + assert_equal nil, @c1.find_class_method_named('none') + + m = @c1.find_class_method_named('m') + assert_instance_of RDoc::AnyMethod, m + assert m.singleton + end + def test_find_constant_named assert_equal nil, @c1.find_constant_named('NONE') assert_equal ':const', @c1.find_constant_named('CONST').value @@ -248,7 +256,7 @@ m = @c1.find_instance_method_named('m') assert_instance_of RDoc::AnyMethod, m - assert_equal false, m.singleton + refute m.singleton end def test_find_local_symbol @@ -278,6 +286,12 @@ assert_equal @c2_c3, @c2.find_symbol('C3') end + def test_find_symbol_method + assert_equal @c1__m, @c1.find_symbol('m') + assert_equal @c1_m, @c1.find_symbol('#m') + assert_equal @c1__m, @c1.find_symbol('::m') + end + def test_spaceship assert_equal(-1, @c2.<=>(@c3)) assert_equal 0, @c2.<=>(@c2) Index: test/rdoc/xref_test_case.rb =================================================================== --- test/rdoc/xref_test_case.rb (revision 27395) +++ test/rdoc/xref_test_case.rb (revision 27396) @@ -13,7 +13,6 @@ def setup RDoc::TopLevel.reset - RDoc::AnyMethod.reset @file_name = 'xref_data.rb' @xref_data = RDoc::TopLevel.new @file_name @@ -36,6 +35,9 @@ rdoc.generator = generator @c1 = @xref_data.find_module_named 'C1' + @c1_m = @c1.method_list.last # C1#m + @c1__m = @c1.method_list.first # C1::m + @c2 = @xref_data.find_module_named 'C2' @c2_c3 = @xref_data.find_module_named 'C2::C3' @c3 = @xref_data.find_module_named 'C3' Index: test/rdoc/test_rdoc_markup_to_html_crossref.rb =================================================================== --- test/rdoc/test_rdoc_markup_to_html_crossref.rb (revision 27395) +++ test/rdoc/test_rdoc_markup_to_html_crossref.rb (revision 27396) @@ -27,31 +27,30 @@ refute_ref '#m', '#m' + assert_ref '../C1.html#method-c-m', 'C1::m' assert_ref '../C2/C3.html', 'C2::C3' - assert_ref '../C2/C3.html#M000002', 'C2::C3#m' + assert_ref '../C2/C3.html#method-i-m', 'C2::C3#m' assert_ref '../C2/C3/H1.html', 'C3::H1' assert_ref '../C4.html', 'C4' - # TODO there is a C3::H2 in the top-level namespace and RDoc should follow - # constant scoping rules - refute_ref 'C3::H2', 'C3::H2' + assert_ref '../C3/H2.html', 'C3::H2' refute_ref 'H1', 'H1' end def test_handle_special_CROSSREF_C2_C3 @xref = RDoc::Markup::ToHtmlCrossref.new 'classes/C2/C3.html', @c2_c3, true - assert_ref '../../C2/C3.html#M000002', '#m' + assert_ref '../../C2/C3.html#method-i-m', '#m' assert_ref '../../C2/C3.html', 'C3' - assert_ref '../../C2/C3.html#M000002', 'C3#m' + assert_ref '../../C2/C3.html#method-i-m', 'C3#m' assert_ref '../../C2/C3/H1.html', 'H1' assert_ref '../../C2/C3/H1.html', 'C3::H1' assert_ref '../../C4.html', 'C4' - refute_ref 'C3::H2', 'C3::H2' + assert_ref '../../C3/H2.html', 'C3::H2' end def test_handle_special_CROSSREF_C3 @@ -105,30 +104,34 @@ def test_handle_special_CROSSREF_method refute_ref 'm', 'm' - assert_ref 'C1.html#M000000', '#m' + assert_ref 'C1.html#method-i-m', '#m' + assert_ref 'C1.html#method-c-m', '::m' - assert_ref 'C1.html#M000000', 'C1#m' - assert_ref 'C1.html#M000000', 'C1#m()' - assert_ref 'C1.html#M000000', 'C1#m(*)' + assert_ref 'C1.html#method-i-m', 'C1#m' + assert_ref 'C1.html#method-i-m', 'C1.m' + assert_ref 'C1.html#method-c-m', 'C1::m' - assert_ref 'C1.html#M000000', 'C1.m' - assert_ref 'C1.html#M000000', 'C1.m()' - assert_ref 'C1.html#M000000', 'C1.m(*)' + assert_ref 'C1.html#method-i-m', 'C1#m' + assert_ref 'C1.html#method-i-m', 'C1#m()' + assert_ref 'C1.html#method-i-m', 'C1#m(*)' - # HACK should this work - #assert_ref 'classes/C1.html#M000001', 'C1::m' - #assert_ref 'classes/C1.html#M000001', 'C1::m()' - #assert_ref 'classes/C1.html#M000001', 'C1::m(*)' + assert_ref 'C1.html#method-i-m', 'C1.m' + assert_ref 'C1.html#method-i-m', 'C1.m()' + assert_ref 'C1.html#method-i-m', 'C1.m(*)' - assert_ref 'C2/C3.html#M000002', 'C2::C3#m' + assert_ref 'C1.html#method-c-m', 'C1::m' + assert_ref 'C1.html#method-c-m', 'C1::m()' + assert_ref 'C1.html#method-c-m', 'C1::m(*)' - assert_ref 'C2/C3.html#M000002', 'C2::C3.m' + assert_ref 'C2/C3.html#method-i-m', 'C2::C3#m' - assert_ref 'C2/C3/H1.html#M000003', 'C2::C3::H1#m?' + assert_ref 'C2/C3.html#method-i-m', 'C2::C3.m' - assert_ref 'C2/C3.html#M000002', '::C2::C3#m' - assert_ref 'C2/C3.html#M000002', '::C2::C3#m()' - assert_ref 'C2/C3.html#M000002', '::C2::C3#m(*)' + assert_ref 'C2/C3/H1.html#method-i-m%3F', 'C2::C3::H1#m?' + + assert_ref 'C2/C3.html#method-i-m', '::C2::C3#m' + assert_ref 'C2/C3.html#method-i-m', '::C2::C3#m()' + assert_ref 'C2/C3.html#method-i-m', '::C2::C3#m(*)' end def test_handle_special_CROSSREF_no_ref Index: test/rdoc/test_rdoc_any_method.rb =================================================================== --- test/rdoc/test_rdoc_any_method.rb (revision 27395) +++ test/rdoc/test_rdoc_any_method.rb (revision 27396) @@ -2,6 +2,16 @@ class RDocAnyMethodTest < XrefTestCase + def test_aref + m = RDoc::AnyMethod.new nil, 'method?' + + assert_equal 'method-i-method%3F', m.aref + + m.singleton = true + + assert_equal 'method-c-method%3F', m.aref + end + def test_arglists m = RDoc::AnyMethod.new nil, 'method' Index: test/rdoc/test_rdoc_parser_ruby.rb =================================================================== --- test/rdoc/test_rdoc_parser_ruby.rb (revision 27395) +++ test/rdoc/test_rdoc_parser_ruby.rb (revision 27396) @@ -1210,6 +1210,33 @@ assert_equal 1, @top_level.requires.length end + def test_parse_statements_while_begin + util_parser <<-RUBY +class A + def a + while begin a; b end + end + end + + def b + end +end + RUBY + + @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL, nil, '' + + c_a = @top_level.classes.first + assert_equal 'A', c_a.full_name + + assert_equal 1, @top_level.classes.length + + m_a = c_a.method_list.first + m_b = c_a.method_list.last + + assert_equal 'A#a', m_a.full_name + assert_equal 'A#b', m_b.full_name + end + def test_parse_top_level_statements_alias_method content = <<-CONTENT class A -- ML: ruby-changes@q... Info: http://www.atdot.net/~ko1/quickml/