rdoc 3.1 → 6.3.3
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of rdoc might be problematic. Click here for more details.
- checksums.yaml +7 -0
- data/CONTRIBUTING.rdoc +220 -0
- data/CVE-2013-0256.rdoc +49 -0
- data/ExampleMarkdown.md +37 -0
- data/ExampleRDoc.rdoc +208 -0
- data/Gemfile +12 -0
- data/History.rdoc +1666 -0
- data/LEGAL.rdoc +50 -0
- data/LICENSE.rdoc +57 -0
- data/README.rdoc +129 -0
- data/RI.rdoc +57 -0
- data/Rakefile +84 -81
- data/TODO.rdoc +59 -0
- data/bin/console +7 -0
- data/bin/setup +6 -0
- data/{bin → exe}/rdoc +11 -2
- data/exe/ri +12 -0
- data/lib/rdoc/alias.rb +1 -2
- data/lib/rdoc/anon_class.rb +3 -2
- data/lib/rdoc/any_method.rb +234 -40
- data/lib/rdoc/attr.rb +79 -11
- data/lib/rdoc/class_module.rb +443 -71
- data/lib/rdoc/code_object.rb +216 -20
- data/lib/rdoc/code_objects.rb +4 -21
- data/lib/rdoc/comment.rb +250 -0
- data/lib/rdoc/constant.rb +110 -9
- data/lib/rdoc/context/section.rb +232 -0
- data/lib/rdoc/context.rb +392 -172
- data/lib/rdoc/cross_reference.rb +202 -0
- data/lib/rdoc/encoding.rb +83 -28
- data/lib/rdoc/erb_partial.rb +19 -0
- data/lib/rdoc/erbio.rb +8 -3
- data/lib/rdoc/extend.rb +10 -0
- data/lib/rdoc/generator/darkfish.rb +507 -84
- data/lib/rdoc/generator/json_index.rb +300 -0
- data/lib/rdoc/generator/markup.rb +27 -74
- data/lib/rdoc/generator/pot/message_extractor.rb +68 -0
- data/lib/rdoc/generator/pot/po.rb +84 -0
- data/lib/rdoc/generator/pot/po_entry.rb +141 -0
- data/lib/rdoc/generator/pot.rb +98 -0
- data/lib/rdoc/generator/ri.rb +8 -62
- data/lib/rdoc/generator/template/darkfish/_footer.rhtml +5 -0
- data/lib/rdoc/generator/template/darkfish/_head.rhtml +22 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_VCS_info.rhtml +19 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml +9 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml +15 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_in_files.rhtml +9 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml +15 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml +15 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml +12 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_navigation.rhtml +11 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml +12 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml +11 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml +14 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml +11 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml +18 -0
- data/lib/rdoc/generator/template/darkfish/class.rhtml +172 -0
- data/lib/rdoc/generator/template/darkfish/css/fonts.css +167 -0
- data/lib/rdoc/generator/template/darkfish/css/rdoc.css +639 -0
- data/lib/rdoc/generator/template/darkfish/fonts/Lato-Light.ttf +0 -0
- data/lib/rdoc/generator/template/darkfish/fonts/Lato-LightItalic.ttf +0 -0
- data/lib/rdoc/generator/template/darkfish/fonts/Lato-Regular.ttf +0 -0
- data/lib/rdoc/generator/template/darkfish/fonts/Lato-RegularItalic.ttf +0 -0
- data/lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Bold.ttf +0 -0
- data/lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Regular.ttf +0 -0
- data/lib/rdoc/generator/template/darkfish/images/add.png +0 -0
- data/lib/rdoc/generator/template/darkfish/images/arrow_up.png +0 -0
- data/lib/rdoc/generator/template/darkfish/images/delete.png +0 -0
- data/lib/rdoc/generator/template/darkfish/images/tag_blue.png +0 -0
- data/lib/rdoc/generator/template/darkfish/images/transparent.png +0 -0
- data/lib/rdoc/generator/template/darkfish/index.rhtml +18 -60
- data/lib/rdoc/generator/template/darkfish/js/darkfish.js +51 -83
- data/lib/rdoc/generator/template/darkfish/js/search.js +110 -0
- data/lib/rdoc/generator/template/darkfish/page.rhtml +18 -0
- data/lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml +18 -0
- data/lib/rdoc/generator/template/darkfish/servlet_root.rhtml +62 -0
- data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml +58 -0
- data/lib/rdoc/generator/template/json_index/.document +1 -0
- data/lib/rdoc/generator/template/json_index/js/navigation.js +105 -0
- data/lib/rdoc/generator/template/json_index/js/searcher.js +229 -0
- data/lib/rdoc/generator.rb +24 -13
- data/lib/rdoc/ghost_method.rb +1 -2
- data/lib/rdoc/i18n/locale.rb +102 -0
- data/lib/rdoc/i18n/text.rb +126 -0
- data/lib/rdoc/i18n.rb +10 -0
- data/lib/rdoc/include.rb +5 -95
- data/lib/rdoc/known_classes.rb +5 -2
- data/lib/rdoc/markdown/entities.rb +2132 -0
- data/lib/rdoc/markdown/literals.kpeg +23 -0
- data/lib/rdoc/markdown/literals.rb +416 -0
- data/lib/rdoc/markdown.kpeg +1237 -0
- data/lib/rdoc/markdown.rb +16684 -0
- data/lib/rdoc/markup/attr_changer.rb +23 -0
- data/lib/rdoc/markup/attr_span.rb +36 -0
- data/lib/rdoc/markup/attribute_manager.rb +135 -62
- data/lib/rdoc/markup/attributes.rb +71 -0
- data/lib/rdoc/markup/blank_line.rb +1 -0
- data/lib/rdoc/markup/block_quote.rb +15 -0
- data/lib/rdoc/markup/document.rb +96 -9
- data/lib/rdoc/markup/formatter.rb +138 -25
- data/lib/rdoc/markup/hard_break.rb +32 -0
- data/lib/rdoc/markup/heading.rb +61 -2
- data/lib/rdoc/markup/include.rb +43 -0
- data/lib/rdoc/markup/indented_paragraph.rb +48 -0
- data/lib/rdoc/markup/list.rb +25 -4
- data/lib/rdoc/markup/list_item.rb +18 -4
- data/lib/rdoc/markup/paragraph.rb +15 -0
- data/lib/rdoc/markup/parser.rb +180 -88
- data/lib/rdoc/markup/pre_process.rb +183 -38
- data/lib/rdoc/markup/raw.rb +6 -5
- data/lib/rdoc/markup/regexp_handling.rb +41 -0
- data/lib/rdoc/markup/rule.rb +1 -0
- data/lib/rdoc/markup/table.rb +47 -0
- data/lib/rdoc/markup/to_ansi.rb +17 -7
- data/lib/rdoc/markup/to_bs.rb +5 -8
- data/lib/rdoc/markup/to_html.rb +238 -137
- data/lib/rdoc/markup/to_html_crossref.rb +125 -152
- data/lib/rdoc/markup/to_html_snippet.rb +285 -0
- data/lib/rdoc/markup/to_joined_paragraph.rb +47 -0
- data/lib/rdoc/markup/to_label.rb +75 -0
- data/lib/rdoc/markup/to_markdown.rb +192 -0
- data/lib/rdoc/markup/to_rdoc.rb +85 -15
- data/lib/rdoc/markup/to_table_of_contents.rb +89 -0
- data/lib/rdoc/markup/to_test.rb +2 -4
- data/lib/rdoc/markup/to_tt_only.rb +121 -0
- data/lib/rdoc/markup/verbatim.rb +39 -0
- data/lib/rdoc/markup.rb +388 -110
- data/lib/rdoc/meta_method.rb +1 -2
- data/lib/rdoc/method_attr.rb +87 -21
- data/lib/rdoc/mixin.rb +121 -0
- data/lib/rdoc/normal_class.rb +39 -10
- data/lib/rdoc/normal_module.rb +22 -7
- data/lib/rdoc/options.rb +613 -73
- data/lib/rdoc/parser/c.rb +621 -287
- data/lib/rdoc/parser/changelog.rb +335 -0
- data/lib/rdoc/parser/markdown.rb +24 -0
- data/lib/rdoc/parser/rd.rb +23 -0
- data/lib/rdoc/parser/ripper_state_lex.rb +590 -0
- data/lib/rdoc/parser/ruby.rb +1368 -762
- data/lib/rdoc/parser/ruby_tools.rb +42 -35
- data/lib/rdoc/parser/simple.rb +23 -11
- data/lib/rdoc/parser/text.rb +12 -0
- data/lib/rdoc/parser.rb +162 -89
- data/lib/rdoc/rd/block_parser.rb +1056 -0
- data/lib/rdoc/rd/block_parser.ry +639 -0
- data/lib/rdoc/rd/inline.rb +72 -0
- data/lib/rdoc/rd/inline_parser.rb +1208 -0
- data/lib/rdoc/rd/inline_parser.ry +593 -0
- data/lib/rdoc/rd.rb +100 -0
- data/lib/rdoc/rdoc.rb +208 -115
- data/lib/rdoc/require.rb +1 -2
- data/lib/rdoc/ri/driver.rb +734 -239
- data/lib/rdoc/ri/formatter.rb +1 -0
- data/lib/rdoc/ri/paths.rb +91 -48
- data/lib/rdoc/ri/store.rb +3 -261
- data/lib/rdoc/ri/task.rb +71 -0
- data/lib/rdoc/ri.rb +5 -2
- data/lib/rdoc/rubygems_hook.rb +246 -0
- data/lib/rdoc/servlet.rb +451 -0
- data/lib/rdoc/single_class.rb +14 -2
- data/lib/rdoc/stats/normal.rb +19 -12
- data/lib/rdoc/stats/quiet.rb +1 -0
- data/lib/rdoc/stats/verbose.rb +1 -0
- data/lib/rdoc/stats.rb +262 -104
- data/lib/rdoc/store.rb +979 -0
- data/lib/rdoc/task.rb +84 -44
- data/lib/rdoc/text.rb +117 -72
- data/lib/rdoc/token_stream.rb +73 -4
- data/lib/rdoc/tom_doc.rb +263 -0
- data/lib/rdoc/top_level.rb +111 -261
- data/lib/rdoc/version.rb +8 -0
- data/lib/rdoc.rb +127 -64
- data/man/ri.1 +247 -0
- data/rdoc.gemspec +249 -0
- metadata +171 -291
- data/.autotest +0 -16
- data/.document +0 -5
- data/History.txt +0 -594
- data/LICENSE.txt +0 -57
- data/Manifest.txt +0 -158
- data/README.txt +0 -45
- data/RI.txt +0 -58
- data/bin/ri +0 -5
- data/lib/rdoc/gauntlet.rb +0 -52
- data/lib/rdoc/generator/template/darkfish/classpage.rhtml +0 -296
- data/lib/rdoc/generator/template/darkfish/filepage.rhtml +0 -124
- data/lib/rdoc/generator/template/darkfish/js/jquery.js +0 -32
- data/lib/rdoc/generator/template/darkfish/js/quicksearch.js +0 -114
- data/lib/rdoc/generator/template/darkfish/js/thickbox-compressed.js +0 -10
- data/lib/rdoc/generator/template/darkfish/rdoc.css +0 -706
- data/lib/rdoc/markup/formatter_test_case.rb +0 -689
- data/lib/rdoc/markup/inline.rb +0 -137
- data/lib/rdoc/markup/text_formatter_test_case.rb +0 -116
- data/lib/rdoc/ruby_lex.rb +0 -1291
- data/lib/rdoc/ruby_token.rb +0 -416
- data/test/README +0 -1
- data/test/binary.dat +0 -0
- data/test/hidden.zip.txt +0 -1
- data/test/test.ja.rdoc +0 -10
- data/test/test.ja.txt +0 -8
- data/test/test.txt +0 -1
- data/test/test_attribute_manager.rb +0 -120
- data/test/test_rdoc_alias.rb +0 -13
- data/test/test_rdoc_any_method.rb +0 -126
- data/test/test_rdoc_attr.rb +0 -61
- data/test/test_rdoc_class_module.rb +0 -233
- data/test/test_rdoc_code_object.rb +0 -165
- data/test/test_rdoc_constant.rb +0 -15
- data/test/test_rdoc_context.rb +0 -370
- data/test/test_rdoc_encoding.rb +0 -166
- data/test/test_rdoc_generator_darkfish.rb +0 -119
- data/test/test_rdoc_generator_ri.rb +0 -76
- data/test/test_rdoc_include.rb +0 -96
- data/test/test_rdoc_markup.rb +0 -37
- data/test/test_rdoc_markup_attribute_manager.rb +0 -240
- data/test/test_rdoc_markup_document.rb +0 -51
- data/test/test_rdoc_markup_paragraph.rb +0 -9
- data/test/test_rdoc_markup_parser.rb +0 -1395
- data/test/test_rdoc_markup_pre_process.rb +0 -185
- data/test/test_rdoc_markup_raw.rb +0 -27
- data/test/test_rdoc_markup_to_ansi.rb +0 -328
- data/test/test_rdoc_markup_to_bs.rb +0 -341
- data/test/test_rdoc_markup_to_html.rb +0 -335
- data/test/test_rdoc_markup_to_html_crossref.rb +0 -169
- data/test/test_rdoc_markup_to_rdoc.rb +0 -327
- data/test/test_rdoc_method_attr.rb +0 -122
- data/test/test_rdoc_normal_class.rb +0 -17
- data/test/test_rdoc_normal_module.rb +0 -31
- data/test/test_rdoc_options.rb +0 -342
- data/test/test_rdoc_parser.rb +0 -83
- data/test/test_rdoc_parser_c.rb +0 -912
- data/test/test_rdoc_parser_ruby.rb +0 -1754
- data/test/test_rdoc_parser_simple.rb +0 -99
- data/test/test_rdoc_rdoc.rb +0 -164
- data/test/test_rdoc_require.rb +0 -25
- data/test/test_rdoc_ri_driver.rb +0 -846
- data/test/test_rdoc_ri_paths.rb +0 -43
- data/test/test_rdoc_ri_store.rb +0 -352
- data/test/test_rdoc_ruby_lex.rb +0 -23
- data/test/test_rdoc_stats.rb +0 -38
- data/test/test_rdoc_task.rb +0 -92
- data/test/test_rdoc_text.rb +0 -251
- data/test/test_rdoc_top_level.rb +0 -120
- data/test/xref_data.rb +0 -62
- data/test/xref_test_case.rb +0 -61
- data.tar.gz.sig +0 -3
- metadata.gz.sig +0 -0
data/test/test_rdoc_attr.rb
DELETED
@@ -1,61 +0,0 @@
|
|
1
|
-
require 'rubygems'
|
2
|
-
require 'minitest/autorun'
|
3
|
-
require 'rdoc/rdoc'
|
4
|
-
|
5
|
-
class TestRDocAttr < MiniTest::Unit::TestCase
|
6
|
-
|
7
|
-
def setup
|
8
|
-
@a = RDoc::Attr.new nil, 'attr', 'RW', ''
|
9
|
-
end
|
10
|
-
|
11
|
-
def test_aref
|
12
|
-
m = RDoc::Attr.new nil, 'attr', 'RW', nil
|
13
|
-
|
14
|
-
assert_equal 'attribute-i-attr', m.aref
|
15
|
-
end
|
16
|
-
|
17
|
-
def test_arglists
|
18
|
-
assert_nil @a.arglists
|
19
|
-
end
|
20
|
-
|
21
|
-
def test_block_params
|
22
|
-
assert_nil @a.block_params
|
23
|
-
end
|
24
|
-
|
25
|
-
def test_call_seq
|
26
|
-
assert_nil @a.call_seq
|
27
|
-
end
|
28
|
-
|
29
|
-
def test_definition
|
30
|
-
assert_equal 'attr_accessor', @a.definition
|
31
|
-
|
32
|
-
@a.rw = 'R'
|
33
|
-
|
34
|
-
assert_equal 'attr_reader', @a.definition
|
35
|
-
|
36
|
-
@a.rw = 'W'
|
37
|
-
|
38
|
-
assert_equal 'attr_writer', @a.definition
|
39
|
-
end
|
40
|
-
|
41
|
-
def test_full_name
|
42
|
-
assert_equal '(unknown)#attr', @a.full_name
|
43
|
-
end
|
44
|
-
|
45
|
-
def test_params
|
46
|
-
assert_nil @a.params
|
47
|
-
end
|
48
|
-
|
49
|
-
def test_singleton
|
50
|
-
refute @a.singleton
|
51
|
-
end
|
52
|
-
|
53
|
-
def test_type
|
54
|
-
assert_equal 'instance', @a.type
|
55
|
-
|
56
|
-
@a.singleton = true
|
57
|
-
assert_equal 'class', @a.type
|
58
|
-
end
|
59
|
-
|
60
|
-
end
|
61
|
-
|
@@ -1,233 +0,0 @@
|
|
1
|
-
require File.expand_path '../xref_test_case', __FILE__
|
2
|
-
|
3
|
-
class TestRDocClassModule < XrefTestCase
|
4
|
-
|
5
|
-
def setup
|
6
|
-
super
|
7
|
-
|
8
|
-
@RM = RDoc::Markup
|
9
|
-
end
|
10
|
-
|
11
|
-
def test_comment_equals
|
12
|
-
cm = RDoc::ClassModule.new 'Klass'
|
13
|
-
cm.comment = '# comment 1'
|
14
|
-
|
15
|
-
assert_equal 'comment 1', cm.comment
|
16
|
-
|
17
|
-
cm.comment = '# comment 2'
|
18
|
-
|
19
|
-
assert_equal "comment 1\n---\ncomment 2", cm.comment
|
20
|
-
|
21
|
-
cm.comment = "# * comment 3"
|
22
|
-
|
23
|
-
assert_equal "comment 1\n---\ncomment 2\n---\n* comment 3", cm.comment
|
24
|
-
end
|
25
|
-
|
26
|
-
# handle making a short module alias of yourself
|
27
|
-
|
28
|
-
def test_find_class_named
|
29
|
-
@c2.classes_hash['C2'] = @c2
|
30
|
-
|
31
|
-
assert_nil @c2.find_class_named('C1')
|
32
|
-
end
|
33
|
-
|
34
|
-
def test_merge
|
35
|
-
cm1 = RDoc::ClassModule.new 'Klass'
|
36
|
-
cm1.comment = 'klass 1'
|
37
|
-
cm1.add_attribute RDoc::Attr.new(nil, 'a1', 'RW', '')
|
38
|
-
cm1.add_attribute RDoc::Attr.new(nil, 'a3', 'R', '')
|
39
|
-
cm1.add_constant RDoc::Constant.new('C1', nil, '')
|
40
|
-
cm1.add_include RDoc::Include.new('I1', '')
|
41
|
-
cm1.add_method RDoc::AnyMethod.new(nil, 'm1')
|
42
|
-
|
43
|
-
cm2 = RDoc::ClassModule.new 'Klass'
|
44
|
-
cm2.instance_variable_set(:@comment,
|
45
|
-
@RM::Document.new(
|
46
|
-
@RM::Paragraph.new('klass 2')))
|
47
|
-
cm2.add_attribute RDoc::Attr.new(nil, 'a2', 'RW', '')
|
48
|
-
cm2.add_attribute RDoc::Attr.new(nil, 'a3', 'W', '')
|
49
|
-
cm2.add_constant RDoc::Constant.new('C2', nil, '')
|
50
|
-
cm2.add_include RDoc::Include.new('I2', '')
|
51
|
-
cm2.add_method RDoc::AnyMethod.new(nil, 'm2')
|
52
|
-
|
53
|
-
cm1.merge cm2
|
54
|
-
|
55
|
-
document = @RM::Document.new(
|
56
|
-
@RM::Paragraph.new('klass 2'),
|
57
|
-
@RM::Paragraph.new('klass 1'))
|
58
|
-
|
59
|
-
assert_equal document, cm1.comment
|
60
|
-
|
61
|
-
expected = [
|
62
|
-
RDoc::Attr.new(nil, 'a1', 'RW', ''),
|
63
|
-
RDoc::Attr.new(nil, 'a2', 'RW', ''),
|
64
|
-
RDoc::Attr.new(nil, 'a3', 'RW', ''),
|
65
|
-
]
|
66
|
-
|
67
|
-
expected.each do |a| a.parent = cm1 end
|
68
|
-
assert_equal expected, cm1.attributes.sort
|
69
|
-
|
70
|
-
expected = [
|
71
|
-
RDoc::Constant.new('C1', nil, ''),
|
72
|
-
RDoc::Constant.new('C2', nil, ''),
|
73
|
-
]
|
74
|
-
|
75
|
-
expected.each do |c| c.parent = cm1 end
|
76
|
-
assert_equal expected, cm1.constants.sort
|
77
|
-
|
78
|
-
expected = [
|
79
|
-
RDoc::Include.new('I1', ''),
|
80
|
-
RDoc::Include.new('I2', ''),
|
81
|
-
]
|
82
|
-
|
83
|
-
expected.each do |i| i.parent = cm1 end
|
84
|
-
assert_equal expected, cm1.includes.sort
|
85
|
-
|
86
|
-
expected = [
|
87
|
-
RDoc::AnyMethod.new(nil, 'm1'),
|
88
|
-
RDoc::AnyMethod.new(nil, 'm2'),
|
89
|
-
]
|
90
|
-
|
91
|
-
expected.each do |m| m.parent = cm1 end
|
92
|
-
assert_equal expected, cm1.method_list.sort
|
93
|
-
end
|
94
|
-
|
95
|
-
def test_remove_nodoc_children
|
96
|
-
parent = RDoc::ClassModule.new 'A'
|
97
|
-
parent.modules_hash.replace 'B' => true, 'C' => true
|
98
|
-
RDoc::TopLevel.all_modules_hash.replace 'A::B' => true
|
99
|
-
|
100
|
-
parent.classes_hash.replace 'D' => true, 'E' => true
|
101
|
-
RDoc::TopLevel.all_classes_hash.replace 'A::D' => true
|
102
|
-
|
103
|
-
parent.remove_nodoc_children
|
104
|
-
|
105
|
-
assert_equal %w[B], parent.modules_hash.keys
|
106
|
-
assert_equal %w[D], parent.classes_hash.keys
|
107
|
-
end
|
108
|
-
|
109
|
-
def test_superclass
|
110
|
-
assert_equal @c3_h1, @c3_h2.superclass
|
111
|
-
end
|
112
|
-
|
113
|
-
def test_update_aliases_class
|
114
|
-
n1 = @xref_data.add_module RDoc::NormalClass, 'N1'
|
115
|
-
n1_k2 = n1.add_module RDoc::NormalClass, 'N2'
|
116
|
-
|
117
|
-
n1.add_module_alias n1_k2, 'A1'
|
118
|
-
|
119
|
-
n1_a1_c = n1.constants.find { |c| c.name == 'A1' }
|
120
|
-
refute_nil n1_a1_c
|
121
|
-
assert_equal n1_k2, n1_a1_c.is_alias_for, 'sanity check'
|
122
|
-
|
123
|
-
n1.update_aliases
|
124
|
-
|
125
|
-
n1_a1_k = @xref_data.find_class_or_module 'N1::A1'
|
126
|
-
refute_nil n1_a1_k
|
127
|
-
assert_equal n1_k2, n1_a1_k.is_alias_for
|
128
|
-
refute_equal n1_k2, n1_a1_k
|
129
|
-
|
130
|
-
assert_equal 1, n1_k2.aliases.length
|
131
|
-
assert_equal n1_a1_k, n1_k2.aliases.first
|
132
|
-
|
133
|
-
assert_equal 'N1::N2', n1_k2.full_name
|
134
|
-
assert_equal 'N1::A1', n1_a1_k.full_name
|
135
|
-
end
|
136
|
-
|
137
|
-
def test_update_aliases_module
|
138
|
-
n1 = @xref_data.add_module RDoc::NormalModule, 'N1'
|
139
|
-
n1_n2 = n1.add_module RDoc::NormalModule, 'N2'
|
140
|
-
|
141
|
-
n1.add_module_alias n1_n2, 'A1'
|
142
|
-
|
143
|
-
n1_a1_c = n1.constants.find { |c| c.name == 'A1' }
|
144
|
-
refute_nil n1_a1_c
|
145
|
-
assert_equal n1_n2, n1_a1_c.is_alias_for, 'sanity check'
|
146
|
-
|
147
|
-
n1.update_aliases
|
148
|
-
|
149
|
-
n1_a1_m = @xref_data.find_class_or_module 'N1::A1'
|
150
|
-
refute_nil n1_a1_m
|
151
|
-
assert_equal n1_n2, n1_a1_m.is_alias_for
|
152
|
-
refute_equal n1_n2, n1_a1_m
|
153
|
-
|
154
|
-
assert_equal 1, n1_n2.aliases.length
|
155
|
-
assert_equal n1_a1_m, n1_n2.aliases.first
|
156
|
-
|
157
|
-
assert_equal 'N1::N2', n1_n2.full_name
|
158
|
-
assert_equal 'N1::A1', n1_a1_m.full_name
|
159
|
-
end
|
160
|
-
|
161
|
-
def test_update_aliases_reparent
|
162
|
-
l1 = @xref_data.add_module RDoc::NormalModule, 'L1'
|
163
|
-
l1_l2 = l1.add_module RDoc::NormalModule, 'L2'
|
164
|
-
o1 = @xref_data.add_module RDoc::NormalModule, 'O1'
|
165
|
-
|
166
|
-
o1.add_module_alias l1_l2, 'A1'
|
167
|
-
|
168
|
-
o1_a1_c = o1.constants.find { |c| c.name == 'A1' }
|
169
|
-
refute_nil o1_a1_c
|
170
|
-
assert_equal l1_l2, o1_a1_c.is_alias_for
|
171
|
-
refute_equal l1_l2, o1_a1_c
|
172
|
-
|
173
|
-
o1.update_aliases
|
174
|
-
|
175
|
-
o1_a1_m = @xref_data.find_class_or_module 'O1::A1'
|
176
|
-
refute_nil o1_a1_m
|
177
|
-
assert_equal l1_l2, o1_a1_m.is_alias_for
|
178
|
-
|
179
|
-
assert_equal 1, l1_l2.aliases.length
|
180
|
-
assert_equal o1_a1_m, l1_l2.aliases[0]
|
181
|
-
|
182
|
-
assert_equal 'L1::L2', l1_l2.full_name
|
183
|
-
assert_equal 'O1::A1', o1_a1_m.full_name
|
184
|
-
end
|
185
|
-
|
186
|
-
def test_update_includes
|
187
|
-
a = RDoc::Include.new 'M1', nil
|
188
|
-
b = RDoc::Include.new 'M2', nil
|
189
|
-
c = RDoc::Include.new 'C', nil
|
190
|
-
|
191
|
-
@c1.add_include a
|
192
|
-
@c1.add_include b
|
193
|
-
@c1.add_include c
|
194
|
-
@c1.ancestors # cache included modules
|
195
|
-
|
196
|
-
@m1_m2.document_self = nil
|
197
|
-
assert @m1_m2.remove_from_documentation?
|
198
|
-
|
199
|
-
assert RDoc::TopLevel.all_modules_hash.key? @m1_m2.full_name
|
200
|
-
refute RDoc::TopLevel.all_modules_hash[@m1_m2.full_name].nil?
|
201
|
-
RDoc::TopLevel.remove_nodoc RDoc::TopLevel.all_modules_hash
|
202
|
-
refute RDoc::TopLevel.all_modules_hash.key? @m1_m2.full_name
|
203
|
-
|
204
|
-
@c1.update_includes
|
205
|
-
|
206
|
-
assert_equal [a, c], @c1.includes
|
207
|
-
end
|
208
|
-
|
209
|
-
def test_update_includes_with_colons
|
210
|
-
a = RDoc::Include.new 'M1', nil
|
211
|
-
b = RDoc::Include.new 'M1::M2', nil
|
212
|
-
c = RDoc::Include.new 'C', nil
|
213
|
-
|
214
|
-
@c1.add_include a
|
215
|
-
@c1.add_include b
|
216
|
-
@c1.add_include c
|
217
|
-
@c1.ancestors # cache included modules
|
218
|
-
|
219
|
-
@m1_m2.document_self = nil
|
220
|
-
assert @m1_m2.remove_from_documentation?
|
221
|
-
|
222
|
-
assert RDoc::TopLevel.all_modules_hash.key? @m1_m2.full_name
|
223
|
-
refute RDoc::TopLevel.all_modules_hash[@m1_m2.full_name].nil?
|
224
|
-
RDoc::TopLevel.remove_nodoc RDoc::TopLevel.all_modules_hash
|
225
|
-
refute RDoc::TopLevel.all_modules_hash.key? @m1_m2.full_name
|
226
|
-
|
227
|
-
@c1.update_includes
|
228
|
-
|
229
|
-
assert_equal [a, c], @c1.includes
|
230
|
-
end
|
231
|
-
|
232
|
-
end
|
233
|
-
|
@@ -1,165 +0,0 @@
|
|
1
|
-
require 'rubygems'
|
2
|
-
require 'minitest/autorun'
|
3
|
-
require File.expand_path '../xref_test_case', __FILE__
|
4
|
-
require 'rdoc/code_object'
|
5
|
-
|
6
|
-
class TestRDocCodeObject < XrefTestCase
|
7
|
-
|
8
|
-
def setup
|
9
|
-
super
|
10
|
-
|
11
|
-
@co = RDoc::CodeObject.new
|
12
|
-
end
|
13
|
-
|
14
|
-
def test_initialize
|
15
|
-
assert @co.document_self, 'document_self'
|
16
|
-
assert @co.document_children, 'document_children'
|
17
|
-
refute @co.force_documentation, 'force_documentation'
|
18
|
-
refute @co.done_documenting, 'done_documenting'
|
19
|
-
refute @co.received_nodoc, 'received_nodoc'
|
20
|
-
assert_equal '', @co.comment, 'comment is empty'
|
21
|
-
end
|
22
|
-
|
23
|
-
def test_comment_equals
|
24
|
-
@co.comment = ''
|
25
|
-
|
26
|
-
assert_equal '', @co.comment
|
27
|
-
|
28
|
-
@co.comment = 'I am a comment'
|
29
|
-
|
30
|
-
assert_equal 'I am a comment', @co.comment
|
31
|
-
end
|
32
|
-
|
33
|
-
def test_document_children_equals
|
34
|
-
@co.document_children = false
|
35
|
-
refute @co.document_children
|
36
|
-
|
37
|
-
# TODO this is not true anymore:
|
38
|
-
# test all the nodoc stuff etc...
|
39
|
-
#@c2.document_children = false
|
40
|
-
#assert_empty @c2.classes
|
41
|
-
end
|
42
|
-
|
43
|
-
def test_document_self_equals
|
44
|
-
@co.document_self = false
|
45
|
-
refute @co.document_self
|
46
|
-
|
47
|
-
# TODO this is not true anymore:
|
48
|
-
# test all the nodoc stuff etc...
|
49
|
-
#@c1.document_self = false
|
50
|
-
#assert_empty @c1.method_list
|
51
|
-
end
|
52
|
-
|
53
|
-
def test_documented_eh
|
54
|
-
refute @co.documented?
|
55
|
-
|
56
|
-
@co.comment = 'hi'
|
57
|
-
|
58
|
-
assert @co.documented?
|
59
|
-
|
60
|
-
@co.comment.replace ''
|
61
|
-
|
62
|
-
refute @co.documented?
|
63
|
-
|
64
|
-
@co.document_self = nil # notify :nodoc:
|
65
|
-
|
66
|
-
assert @co.documented?
|
67
|
-
end
|
68
|
-
|
69
|
-
def test_done_documenting
|
70
|
-
# once done_documenting is set, other properties refuse to go to "true"
|
71
|
-
@co.done_documenting = true
|
72
|
-
|
73
|
-
@co.document_self = true
|
74
|
-
refute @co.document_self
|
75
|
-
|
76
|
-
@co.document_children = true
|
77
|
-
refute @co.document_children
|
78
|
-
|
79
|
-
@co.force_documentation = true
|
80
|
-
refute @co.force_documentation
|
81
|
-
|
82
|
-
@co.start_doc
|
83
|
-
refute @co.document_self
|
84
|
-
refute @co.document_children
|
85
|
-
|
86
|
-
# turning done_documenting on
|
87
|
-
# resets others to true
|
88
|
-
|
89
|
-
@co.done_documenting = false
|
90
|
-
assert @co.document_self
|
91
|
-
assert @co.document_children
|
92
|
-
end
|
93
|
-
|
94
|
-
def test_full_name_equals
|
95
|
-
@co.full_name = 'hi'
|
96
|
-
|
97
|
-
assert_equal 'hi', @co.instance_variable_get(:@full_name)
|
98
|
-
|
99
|
-
@co.full_name = nil
|
100
|
-
|
101
|
-
assert_nil @co.instance_variable_get(:@full_name)
|
102
|
-
end
|
103
|
-
|
104
|
-
def test_metadata
|
105
|
-
assert_empty @co.metadata
|
106
|
-
|
107
|
-
@co.metadata['markup'] = 'not_rdoc'
|
108
|
-
|
109
|
-
expected = { 'markup' => 'not_rdoc' }
|
110
|
-
|
111
|
-
assert_equal expected, @co.metadata
|
112
|
-
|
113
|
-
assert_equal 'not_rdoc', @co.metadata['markup']
|
114
|
-
end
|
115
|
-
|
116
|
-
def test_parent_file_name
|
117
|
-
assert_equal '(unknown)', @co.parent_file_name
|
118
|
-
assert_equal 'xref_data.rb', @c1.parent_file_name
|
119
|
-
end
|
120
|
-
|
121
|
-
def test_parent_name
|
122
|
-
assert_equal '(unknown)', @co.parent_name
|
123
|
-
assert_equal 'xref_data.rb', @c1.parent_name
|
124
|
-
assert_equal 'C2', @c2_c3.parent_name
|
125
|
-
end
|
126
|
-
|
127
|
-
def test_received_ndoc
|
128
|
-
@co.document_self = false
|
129
|
-
refute @co.received_nodoc
|
130
|
-
|
131
|
-
@co.document_self = nil
|
132
|
-
assert @co.received_nodoc
|
133
|
-
|
134
|
-
@co.document_self = true
|
135
|
-
end
|
136
|
-
|
137
|
-
def test_record_location
|
138
|
-
c = RDoc::CodeObject.new
|
139
|
-
c.record_location @xref_data
|
140
|
-
|
141
|
-
assert_equal 'xref_data.rb', c.file.relative_name
|
142
|
-
end
|
143
|
-
|
144
|
-
def test_start_doc
|
145
|
-
@co.document_self = false
|
146
|
-
@co.document_children = false
|
147
|
-
|
148
|
-
@co.start_doc
|
149
|
-
|
150
|
-
assert @co.document_self
|
151
|
-
assert @co.document_children
|
152
|
-
end
|
153
|
-
|
154
|
-
def test_stop_doc
|
155
|
-
@co.document_self = true
|
156
|
-
@co.document_children = true
|
157
|
-
|
158
|
-
@co.stop_doc
|
159
|
-
|
160
|
-
refute @co.document_self
|
161
|
-
refute @co.document_children
|
162
|
-
end
|
163
|
-
|
164
|
-
end
|
165
|
-
|
data/test/test_rdoc_constant.rb
DELETED