1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
ruby--ruby/test/rdoc/test_rdoc_cross_reference.rb

220 lines
5.2 KiB
Ruby
Raw Normal View History

# frozen_string_literal: true
require_relative 'xref_test_case'
class TestRDocCrossReference < XrefTestCase
EXAMPLE_METHODS = %w'== === != =~ !~ < > <= >= <=> [] []= << >>
-@ +@ ! - + * / % ** !@ ` | & ^ ~ __id__
'
def setup
super
@xref = RDoc::CrossReference.new @c1
end
def assert_ref expected, name
assert_equal expected, @xref.resolve(name, 'fail')
end
def refute_ref name
assert_equal name, @xref.resolve(name, name)
end
def test_METHOD_REGEXP_STR
re = /\A(?:#{RDoc::CrossReference::METHOD_REGEXP_STR})\z/
EXAMPLE_METHODS.each do |x|
re =~ x
assert_equal x, $&
end
end
def test_resolve_C2
@xref = RDoc::CrossReference.new @c2
refute_ref '#m'
assert_ref @c1__m, 'C1::m'
assert_ref @c2_c3, 'C2::C3'
assert_ref @c2_c3_m, 'C2::C3#m'
assert_ref @c2_c3_h1, 'C3::H1'
assert_ref @c4, 'C4'
assert_ref @c3_h2, 'C3::H2'
refute_ref 'H1'
end
def test_resolve_C2_C3
@xref = RDoc::CrossReference.new @c2_c3
assert_ref @c2_c3_m, '#m'
assert_ref @c2_c3, 'C3'
assert_ref @c2_c3_m, 'C3#m'
assert_ref @c2_c3_h1, 'H1'
assert_ref @c2_c3_h1, 'C3::H1'
assert_ref @c4, 'C4'
assert_ref @c3_h2, 'C3::H2'
end
def test_resolve_C3
@xref = RDoc::CrossReference.new @c3
assert_ref @c3, 'C3'
refute_ref '#m'
refute_ref 'C3#m'
assert_ref @c3_h1, 'H1'
assert_ref @c3_h1, 'C3::H1'
assert_ref @c3_h2, 'C3::H2'
assert_ref @c4, 'C4'
end
def test_resolve_C4
@xref = RDoc::CrossReference.new @c4
# C4 ref inside a C4 containing a C4 should resolve to the contained class
assert_ref @c4_c4, 'C4'
end
def test_resolve_C4_C4
@xref = RDoc::CrossReference.new @c4_c4
# A C4 reference inside a C4 class contained within a C4 class should
# resolve to the inner C4 class.
assert_ref @c4_c4, 'C4'
end
def test_resolve_class_and_method_of_the_same_name
assert_ref @c10_class, 'C10'
assert_ref @c10_method, '#C10'
assert_ref @c11_class, 'C11'
assert_ref @c11_method, '#C11'
assert_ref @c10_c11_class, 'C10::C11'
assert_ref @c10_c11_method, 'C10#C11'
end
def test_resolve_class
assert_ref @c1, 'C1'
refute_ref 'H1'
assert_ref @c2, 'C2'
assert_ref @c2_c3, 'C2::C3'
assert_ref @c2_c3_h1, 'C2::C3::H1'
assert_ref @c3, '::C3'
assert_ref @c3_h1, '::C3::H1'
assert_ref @c4_c4, 'C4::C4'
end
def test_resolve_file
refute_ref 'xref_data.rb'
end
def test_resolve_method
assert_ref @c1__m, 'm'
assert_ref @c1__m, '::m'
assert_ref @c1_m, '#m'
assert_ref @c1_plus, '#+'
assert_ref @c1_m, 'C1#m'
assert_ref @c1_plus, 'C1#+'
assert_ref @c1__m, 'C1.m'
assert_ref @c1__m, 'C1::m'
assert_ref @c1_m, 'C1#m'
assert_ref @c1_m, 'C1#m()'
assert_ref @c1_m, 'C1#m(*)'
assert_ref @c1_plus, 'C1#+'
assert_ref @c1_plus, 'C1#+()'
assert_ref @c1_plus, 'C1#+(*)'
assert_ref @c1__m, 'C1.m'
assert_ref @c1__m, 'C1.m()'
assert_ref @c1__m, 'C1.m(*)'
assert_ref @c1__m, 'C1::m'
assert_ref @c1__m, 'C1::m()'
assert_ref @c1__m, 'C1::m(*)'
assert_ref @c2_c3_m, 'C2::C3#m'
assert_ref @c2_c3_m, 'C2::C3.m'
# TODO stop escaping - HTML5 allows anything but space
assert_ref @c2_c3_h1_meh, 'C2::C3::H1#m?'
assert_ref @c2_c3_m, '::C2::C3#m'
assert_ref @c2_c3_m, '::C2::C3#m()'
assert_ref @c2_c3_m, '::C2::C3#m(*)'
end
def test_resolve_the_same_name_in_instance_and_class_method
assert_ref @c9_a_i_foo, 'C9::A#foo'
assert_ref @c9_a_c_bar, 'C9::A::bar'
assert_ref @c9_b_c_foo, 'C9::B::foo'
assert_ref @c9_b_i_bar, 'C9::B#bar'
assert_ref @c9_b_c_foo, 'C9::B.foo'
assert_ref @c9_a_c_bar, 'C9::B.bar'
end
def test_resolve_page
page = @store.add_file 'README.txt', parser: RDoc::Parser::Simple
assert_ref page, 'README'
end
def assert_resolve_method(x)
@c1.methods_hash.clear
i_op = RDoc::AnyMethod.new nil, x
i_op.singleton = false
@c1.add_method i_op
c_op = RDoc::AnyMethod.new nil, x
c_op.singleton = true
@c1.add_method c_op
assert_ref i_op, x
assert_ref i_op, "##{x}"
assert_ref c_op, "::#{x}"
assert_ref i_op, "C1##{x}"
assert_ref c_op, "C1::#{x}"
end
EXAMPLE_METHODS.each do |x|
define_method("test_resolve_method:#{x}") do
assert_resolve_method(x)
end
end
def test_resolve_no_ref
assert_equal '', @xref.resolve('', '')
assert_equal "bogus", @xref.resolve("bogus", "bogus")
assert_equal "\\bogus", @xref.resolve("\\bogus", "\\bogus")
assert_equal "\\\\bogus", @xref.resolve("\\\\bogus", "\\\\bogus")
assert_equal "\\#n", @xref.resolve("\\#n", "fail")
assert_equal "\\#n()", @xref.resolve("\\#n()", "fail")
assert_equal "\\#n(*)", @xref.resolve("\\#n(*)", "fail")
assert_equal "C1", @xref.resolve("\\C1", "fail")
assert_equal "::C3", @xref.resolve("\\::C3", "fail")
assert_equal "succeed", @xref.resolve("::C3::H1#n", "succeed")
assert_equal "succeed", @xref.resolve("::C3::H1#n(*)", "succeed")
assert_equal "\\::C3::H1#n", @xref.resolve("\\::C3::H1#n", "fail")
end
end