kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

Import RDoc 2.5.4

Browse source 
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@27396 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
drbrain 2010-04-19 05:08:28 +00:00
parent 37e59f5583
commit 75ef9e79d6
14 changed files with 169 additions and 77 deletions
Download patch file Download diff file Expand all files Collapse all files

4
ChangeLog
View file

@ -1,3 +1,7 @@
Mon Apr 19 13:58:04 2010 Eric Hodel <drbrain@segment7.net>
* lib/rdoc: Update to RDoc 2.5.4. Fixes #3169, #3160, #3023.
Mon Apr 19 12:46:15 2010 Nobuyoshi Nakada <nobu@ruby-lang.org>
* lib/timeout.rb (Timeout#timeout): propagate errors to the

2
lib/rdoc.rb
View file

@ -383,7 +383,7 @@ module RDoc
##
# 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

29
lib/rdoc/any_method.rb
View file

@ -45,11 +45,6 @@ class RDoc::AnyMethod < RDoc::CodeObject
attr_reader :aliases
##
# Fragment reference for this method
attr_reader :aref
##
# The method we're aliasing
@ -67,21 +62,13 @@ class RDoc::AnyMethod < RDoc::CodeObject
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 @@ class RDoc::AnyMethod < RDoc::CodeObject
@singleton = nil
@token_stream = nil
@visibility = :public
@aref = @@aref
@@aref = @@aref.succ
end
##
@ -111,6 +95,15 @@ class RDoc::AnyMethod < RDoc::CodeObject
@aliases << method
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.
#
@ -248,7 +241,7 @@ class RDoc::AnyMethod < RDoc::CodeObject
# Path to this method
def path
"#{@parent.path}##{@aref}"
"#{@parent.path}##{aref}"
end
##

18
lib/rdoc/code_object.rb
View file

@ -6,6 +6,24 @@ require 'rdoc/text'
#
# 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

28
lib/rdoc/context.rb
View file

@ -510,6 +510,13 @@ class RDoc::Context < RDoc::CodeObject
@attributes.find { |m| m.name == name }
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
@ -535,7 +542,7 @@ class RDoc::Context < RDoc::CodeObject
# 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 @@ class RDoc::Context < RDoc::CodeObject
# 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 @@ class RDoc::Context < RDoc::CodeObject
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 @@ class RDoc::Context < RDoc::CodeObject
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 @@ class RDoc::Context < RDoc::CodeObject
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

34
lib/rdoc/markup/to_html_crossref.rb
View file

@ -21,7 +21,7 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
#
# 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 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
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 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
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,12 +105,9 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
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.
#
@ -119,9 +119,11 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
# (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 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
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

4
lib/rdoc/parser.rb
View file

@ -75,8 +75,10 @@ class RDoc::Parser
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

18
lib/rdoc/parser/ruby.rb
View file

@ -1524,24 +1524,29 @@ class RDoc::Parser::Ruby < RDoc::Parser
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 @@ class RDoc::Parser::Ruby < RDoc::Parser
end
tk = get_tk
end
skip_tkspace false
get_tk if TkDO === peek_tk

1
lib/rdoc/rdoc.rb
View file

@ -353,7 +353,6 @@ The internal error was:
def document(argv)
RDoc::TopLevel.reset
RDoc::Parser::C.reset
RDoc::AnyMethod.reset
@options = RDoc::Options.new
@options.parse argv

10
test/rdoc/test_rdoc_any_method.rb
View file

@ -2,6 +2,16 @@ require File.expand_path '../xref_test_case', __FILE__
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'

16
test/rdoc/test_rdoc_context.rb
View file

@ -227,6 +227,14 @@ class TestRDocContext < XrefTestCase
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 @@ class TestRDocContext < XrefTestCase
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 @@ class TestRDocContext < XrefTestCase
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)

51
test/rdoc/test_rdoc_markup_to_html_crossref.rb
View file

@ -27,31 +27,30 @@ class TestRDocMarkupToHtmlCrossref < XrefTestCase
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 @@ class TestRDocMarkupToHtmlCrossref < XrefTestCase
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

27
test/rdoc/test_rdoc_parser_ruby.rb
View file

@ -1210,6 +1210,33 @@ EOF
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

4
test/rdoc/xref_test_case.rb
View file

@ -13,7 +13,6 @@ class XrefTestCase < MiniTest::Unit::TestCase
def setup
RDoc::TopLevel.reset
RDoc::AnyMethod.reset
@file_name = 'xref_data.rb'
@xref_data = RDoc::TopLevel.new @file_name
@ -36,6 +35,9 @@ class XrefTestCase < MiniTest::Unit::TestCase
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'