rdoc 4.2.1 → 6.3.1
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 +5 -5
- data/CONTRIBUTING.rdoc +8 -7
- data/Gemfile +12 -0
- data/History.rdoc +48 -4
- data/LEGAL.rdoc +2 -2
- data/README.rdoc +5 -5
- data/Rakefile +73 -155
- data/bin/console +7 -0
- data/bin/setup +6 -0
- data/{bin → exe}/rdoc +0 -0
- data/{bin → exe}/ri +0 -0
- data/lib/rdoc/alias.rb +1 -0
- data/lib/rdoc/anon_class.rb +1 -0
- data/lib/rdoc/any_method.rb +59 -14
- data/lib/rdoc/attr.rb +1 -0
- data/lib/rdoc/class_module.rb +5 -2
- data/lib/rdoc/code_object.rb +3 -11
- data/lib/rdoc/code_objects.rb +1 -0
- data/lib/rdoc/comment.rb +32 -11
- data/lib/rdoc/constant.rb +3 -2
- data/lib/rdoc/context/section.rb +7 -13
- data/lib/rdoc/context.rb +78 -23
- data/lib/rdoc/cross_reference.rb +33 -14
- data/lib/rdoc/encoding.rb +92 -55
- data/lib/rdoc/erb_partial.rb +2 -1
- data/lib/rdoc/erbio.rb +8 -3
- data/lib/rdoc/extend.rb +1 -0
- data/lib/rdoc/generator/darkfish.rb +62 -32
- data/lib/rdoc/generator/json_index.rb +8 -5
- data/lib/rdoc/generator/markup.rb +3 -12
- 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 +4 -3
- data/lib/rdoc/generator/ri.rb +1 -0
- data/lib/rdoc/generator/template/darkfish/_footer.rhtml +2 -2
- data/lib/rdoc/generator/template/darkfish/_head.rhtml +11 -8
- data/lib/rdoc/generator/template/darkfish/_sidebar_VCS_info.rhtml +2 -2
- data/lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml +2 -2
- data/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml +7 -7
- data/lib/rdoc/generator/template/darkfish/_sidebar_in_files.rhtml +2 -2
- data/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml +7 -7
- data/lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml +6 -6
- data/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml +5 -5
- data/lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml +5 -5
- data/lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml +5 -5
- data/lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml +4 -4
- data/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml +4 -4
- data/lib/rdoc/generator/template/darkfish/class.rhtml +45 -47
- data/lib/rdoc/generator/template/darkfish/css/fonts.css +6 -6
- data/lib/rdoc/generator/template/darkfish/css/rdoc.css +55 -6
- data/lib/rdoc/generator/template/darkfish/index.rhtml +3 -4
- data/lib/rdoc/generator/template/darkfish/js/darkfish.js +23 -100
- data/lib/rdoc/generator/template/darkfish/js/search.js +32 -31
- data/lib/rdoc/generator/template/darkfish/servlet_root.rhtml +15 -16
- data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml +16 -16
- data/lib/rdoc/generator/template/json_index/js/navigation.js +4 -41
- data/lib/rdoc/generator/template/json_index/js/searcher.js +7 -6
- data/lib/rdoc/generator.rb +1 -1
- data/lib/rdoc/ghost_method.rb +1 -0
- data/lib/rdoc/i18n/locale.rb +2 -1
- data/lib/rdoc/i18n/text.rb +5 -4
- data/lib/rdoc/i18n.rb +3 -2
- data/lib/rdoc/include.rb +1 -0
- data/lib/rdoc/known_classes.rb +1 -0
- data/lib/rdoc/markdown/entities.rb +1 -0
- data/lib/rdoc/markdown/{literals_1_9.kpeg → literals.kpeg} +1 -0
- data/lib/rdoc/markdown/{literals_1_9.rb → literals.rb} +1 -4
- data/lib/rdoc/markdown.kpeg +94 -51
- data/lib/rdoc/markdown.rb +1171 -619
- data/lib/rdoc/markup/attr_changer.rb +1 -0
- data/lib/rdoc/markup/attr_span.rb +9 -2
- data/lib/rdoc/markup/attribute_manager.rb +115 -49
- data/lib/rdoc/markup/attributes.rb +7 -6
- data/lib/rdoc/markup/blank_line.rb +1 -0
- data/lib/rdoc/markup/block_quote.rb +1 -0
- data/lib/rdoc/markup/document.rb +1 -0
- data/lib/rdoc/markup/formatter.rb +25 -23
- data/lib/rdoc/markup/hard_break.rb +1 -0
- data/lib/rdoc/markup/heading.rb +4 -3
- data/lib/rdoc/markup/include.rb +1 -0
- data/lib/rdoc/markup/indented_paragraph.rb +1 -0
- data/lib/rdoc/markup/list.rb +1 -0
- data/lib/rdoc/markup/list_item.rb +1 -0
- data/lib/rdoc/markup/paragraph.rb +1 -0
- data/lib/rdoc/markup/parser.rb +78 -61
- data/lib/rdoc/markup/pre_process.rb +12 -9
- data/lib/rdoc/markup/raw.rb +1 -0
- data/lib/rdoc/markup/regexp_handling.rb +41 -0
- data/lib/rdoc/markup/rule.rb +1 -0
- data/lib/rdoc/markup/to_ansi.rb +1 -0
- data/lib/rdoc/markup/to_bs.rb +4 -5
- data/lib/rdoc/markup/to_html.rb +71 -25
- data/lib/rdoc/markup/to_html_crossref.rb +41 -25
- data/lib/rdoc/markup/to_html_snippet.rb +10 -9
- data/lib/rdoc/markup/to_joined_paragraph.rb +7 -31
- data/lib/rdoc/markup/to_label.rb +10 -9
- data/lib/rdoc/markup/to_markdown.rb +9 -8
- data/lib/rdoc/markup/to_rdoc.rb +35 -6
- data/lib/rdoc/markup/to_table_of_contents.rb +2 -0
- data/lib/rdoc/markup/to_test.rb +1 -0
- data/lib/rdoc/markup/to_tt_only.rb +3 -2
- data/lib/rdoc/markup/verbatim.rb +1 -0
- data/lib/rdoc/markup.rb +14 -16
- data/lib/rdoc/meta_method.rb +1 -0
- data/lib/rdoc/method_attr.rb +2 -1
- data/lib/rdoc/mixin.rb +1 -0
- data/lib/rdoc/normal_class.rb +3 -2
- data/lib/rdoc/normal_module.rb +1 -0
- data/lib/rdoc/options.rb +92 -58
- data/lib/rdoc/parser/c.rb +219 -223
- data/lib/rdoc/parser/changelog.rb +155 -18
- data/lib/rdoc/parser/markdown.rb +1 -0
- data/lib/rdoc/parser/rd.rb +1 -0
- data/lib/rdoc/parser/ripper_state_lex.rb +590 -0
- data/lib/rdoc/parser/ruby.rb +635 -468
- data/lib/rdoc/parser/ruby_tools.rb +33 -33
- data/lib/rdoc/parser/simple.rb +3 -3
- data/lib/rdoc/parser/text.rb +1 -0
- data/lib/rdoc/parser.rb +17 -50
- data/lib/rdoc/rd/block_parser.rb +66 -65
- data/lib/rdoc/rd/block_parser.ry +3 -3
- data/lib/rdoc/rd/inline.rb +5 -4
- data/lib/rdoc/rd/inline_parser.rb +52 -51
- data/lib/rdoc/rd/inline_parser.ry +1 -1
- data/lib/rdoc/rd.rb +1 -0
- data/lib/rdoc/rdoc.rb +68 -63
- data/lib/rdoc/require.rb +1 -0
- data/lib/rdoc/ri/driver.rb +133 -58
- data/lib/rdoc/ri/formatter.rb +1 -0
- data/lib/rdoc/ri/paths.rb +4 -20
- data/lib/rdoc/ri/store.rb +1 -0
- data/lib/rdoc/ri/task.rb +71 -0
- data/lib/rdoc/ri.rb +1 -0
- data/lib/rdoc/rubygems_hook.rb +5 -12
- data/lib/rdoc/servlet.rb +24 -14
- data/lib/rdoc/single_class.rb +1 -0
- data/lib/rdoc/stats/normal.rb +20 -21
- data/lib/rdoc/stats/quiet.rb +1 -0
- data/lib/rdoc/stats/verbose.rb +1 -0
- data/lib/rdoc/stats.rb +1 -0
- data/lib/rdoc/store.rb +41 -41
- data/lib/rdoc/task.rb +2 -3
- data/lib/rdoc/text.rb +19 -38
- data/lib/rdoc/token_stream.rb +56 -32
- data/lib/rdoc/tom_doc.rb +17 -11
- data/lib/rdoc/top_level.rb +9 -2
- data/lib/rdoc/version.rb +8 -0
- data/lib/rdoc.rb +24 -10
- data/man/ri.1 +247 -0
- data/rdoc.gemspec +248 -0
- metadata +43 -236
- data/.autotest +0 -24
- data/.document +0 -5
- data/Manifest.txt +0 -306
- data/lib/gauntlet_rdoc.rb +0 -84
- data/lib/rdoc/generator/template/darkfish/js/jquery.js +0 -4
- data/lib/rdoc/markdown/literals_1_8.kpeg +0 -18
- data/lib/rdoc/markdown/literals_1_8.rb +0 -416
- data/lib/rdoc/markup/formatter_test_case.rb +0 -767
- data/lib/rdoc/markup/inline.rb +0 -1
- data/lib/rdoc/markup/special.rb +0 -40
- data/lib/rdoc/markup/text_formatter_test_case.rb +0 -114
- data/lib/rdoc/ruby_lex.rb +0 -1377
- data/lib/rdoc/ruby_token.rb +0 -460
- data/lib/rdoc/test_case.rb +0 -217
- data/test/MarkdownTest_1.0.3/Amps and angle encoding.text +0 -21
- data/test/MarkdownTest_1.0.3/Auto links.text +0 -13
- data/test/MarkdownTest_1.0.3/Backslash escapes.text +0 -120
- data/test/MarkdownTest_1.0.3/Blockquotes with code blocks.text +0 -11
- data/test/MarkdownTest_1.0.3/Code Blocks.text +0 -14
- data/test/MarkdownTest_1.0.3/Code Spans.text +0 -6
- data/test/MarkdownTest_1.0.3/Hard-wrapped paragraphs with list-like lines.text +0 -8
- data/test/MarkdownTest_1.0.3/Horizontal rules.text +0 -67
- data/test/MarkdownTest_1.0.3/Inline HTML (Advanced).text +0 -15
- data/test/MarkdownTest_1.0.3/Inline HTML (Simple).text +0 -69
- data/test/MarkdownTest_1.0.3/Inline HTML comments.text +0 -13
- data/test/MarkdownTest_1.0.3/Links, inline style.text +0 -12
- data/test/MarkdownTest_1.0.3/Links, reference style.text +0 -71
- data/test/MarkdownTest_1.0.3/Links, shortcut references.text +0 -20
- data/test/MarkdownTest_1.0.3/Literal quotes in titles.text +0 -7
- data/test/MarkdownTest_1.0.3/Markdown Documentation - Basics.text +0 -306
- data/test/MarkdownTest_1.0.3/Markdown Documentation - Syntax.text +0 -888
- data/test/MarkdownTest_1.0.3/Nested blockquotes.text +0 -5
- data/test/MarkdownTest_1.0.3/Ordered and unordered lists.text +0 -131
- data/test/MarkdownTest_1.0.3/Strong and em together.text +0 -7
- data/test/MarkdownTest_1.0.3/Tabs.text +0 -21
- data/test/MarkdownTest_1.0.3/Tidyness.text +0 -5
- data/test/README +0 -1
- data/test/binary.dat +0 -0
- data/test/hidden.zip.txt +0 -1
- data/test/test.ja.largedoc +0 -3
- data/test/test.ja.rdoc +0 -10
- data/test/test.ja.txt +0 -8
- data/test/test.txt +0 -1
- data/test/test_rdoc_alias.rb +0 -13
- data/test/test_rdoc_any_method.rb +0 -460
- data/test/test_rdoc_attr.rb +0 -190
- data/test/test_rdoc_class_module.rb +0 -1492
- data/test/test_rdoc_code_object.rb +0 -450
- data/test/test_rdoc_comment.rb +0 -504
- data/test/test_rdoc_constant.rb +0 -181
- data/test/test_rdoc_context.rb +0 -901
- data/test/test_rdoc_context_section.rb +0 -130
- data/test/test_rdoc_cross_reference.rb +0 -192
- data/test/test_rdoc_encoding.rb +0 -227
- data/test/test_rdoc_extend.rb +0 -94
- data/test/test_rdoc_generator_darkfish.rb +0 -229
- data/test/test_rdoc_generator_json_index.rb +0 -324
- data/test/test_rdoc_generator_markup.rb +0 -59
- data/test/test_rdoc_generator_pot.rb +0 -91
- data/test/test_rdoc_generator_pot_po.rb +0 -51
- data/test/test_rdoc_generator_pot_po_entry.rb +0 -139
- data/test/test_rdoc_generator_ri.rb +0 -78
- data/test/test_rdoc_i18n_locale.rb +0 -73
- data/test/test_rdoc_i18n_text.rb +0 -123
- data/test/test_rdoc_include.rb +0 -108
- data/test/test_rdoc_markdown.rb +0 -980
- data/test/test_rdoc_markdown_test.rb +0 -1884
- data/test/test_rdoc_markup.rb +0 -95
- data/test/test_rdoc_markup_attribute_manager.rb +0 -364
- data/test/test_rdoc_markup_attributes.rb +0 -39
- data/test/test_rdoc_markup_document.rb +0 -207
- data/test/test_rdoc_markup_formatter.rb +0 -175
- data/test/test_rdoc_markup_hard_break.rb +0 -31
- data/test/test_rdoc_markup_heading.rb +0 -29
- data/test/test_rdoc_markup_include.rb +0 -19
- data/test/test_rdoc_markup_indented_paragraph.rb +0 -53
- data/test/test_rdoc_markup_paragraph.rb +0 -32
- data/test/test_rdoc_markup_parser.rb +0 -1680
- data/test/test_rdoc_markup_pre_process.rb +0 -473
- data/test/test_rdoc_markup_raw.rb +0 -22
- data/test/test_rdoc_markup_to_ansi.rb +0 -369
- data/test/test_rdoc_markup_to_bs.rb +0 -366
- data/test/test_rdoc_markup_to_html.rb +0 -662
- data/test/test_rdoc_markup_to_html_crossref.rb +0 -225
- data/test/test_rdoc_markup_to_html_snippet.rb +0 -711
- data/test/test_rdoc_markup_to_joined_paragraph.rb +0 -32
- data/test/test_rdoc_markup_to_label.rb +0 -112
- data/test/test_rdoc_markup_to_markdown.rb +0 -389
- data/test/test_rdoc_markup_to_rdoc.rb +0 -377
- data/test/test_rdoc_markup_to_table_of_contents.rb +0 -126
- data/test/test_rdoc_markup_to_tt_only.rb +0 -246
- data/test/test_rdoc_markup_verbatim.rb +0 -29
- data/test/test_rdoc_method_attr.rb +0 -193
- data/test/test_rdoc_normal_class.rb +0 -47
- data/test/test_rdoc_normal_module.rb +0 -42
- data/test/test_rdoc_options.rb +0 -766
- data/test/test_rdoc_parser.rb +0 -327
- data/test/test_rdoc_parser_c.rb +0 -1896
- data/test/test_rdoc_parser_changelog.rb +0 -315
- data/test/test_rdoc_parser_markdown.rb +0 -61
- data/test/test_rdoc_parser_rd.rb +0 -55
- data/test/test_rdoc_parser_ruby.rb +0 -3322
- data/test/test_rdoc_parser_simple.rb +0 -115
- data/test/test_rdoc_rd.rb +0 -30
- data/test/test_rdoc_rd_block_parser.rb +0 -535
- data/test/test_rdoc_rd_inline.rb +0 -63
- data/test/test_rdoc_rd_inline_parser.rb +0 -177
- data/test/test_rdoc_rdoc.rb +0 -455
- data/test/test_rdoc_require.rb +0 -25
- data/test/test_rdoc_ri_driver.rb +0 -1436
- data/test/test_rdoc_ri_paths.rb +0 -155
- data/test/test_rdoc_ruby_lex.rb +0 -421
- data/test/test_rdoc_ruby_token.rb +0 -19
- data/test/test_rdoc_rubygems_hook.rb +0 -251
- data/test/test_rdoc_servlet.rb +0 -534
- data/test/test_rdoc_single_class.rb +0 -20
- data/test/test_rdoc_stats.rb +0 -722
- data/test/test_rdoc_store.rb +0 -993
- data/test/test_rdoc_task.rb +0 -173
- data/test/test_rdoc_text.rb +0 -557
- data/test/test_rdoc_token_stream.rb +0 -42
- data/test/test_rdoc_tom_doc.rb +0 -520
- data/test/test_rdoc_top_level.rb +0 -287
- data/test/xref_data.rb +0 -76
- data/test/xref_test_case.rb +0 -67
@@ -8,6 +8,7 @@
|
|
8
8
|
*/
|
9
9
|
|
10
10
|
/* Provide console simulation for firebug-less environments */
|
11
|
+
/*
|
11
12
|
if (!("console" in window) || !("firebug" in console)) {
|
12
13
|
var names = ["log", "debug", "info", "warn", "error", "assert", "dir", "dirxml",
|
13
14
|
"group", "groupEnd", "time", "timeEnd", "count", "trace", "profile", "profileEnd"];
|
@@ -16,41 +17,35 @@ if (!("console" in window) || !("firebug" in console)) {
|
|
16
17
|
for (var i = 0; i < names.length; ++i)
|
17
18
|
window.console[names[i]] = function() {};
|
18
19
|
};
|
19
|
-
|
20
|
-
|
21
|
-
/**
|
22
|
-
* Unwrap the first element that matches the given @expr@ from the targets and return them.
|
23
|
-
*/
|
24
|
-
$.fn.unwrap = function( expr ) {
|
25
|
-
return this.each( function() {
|
26
|
-
$(this).parents( expr ).eq( 0 ).after( this ).remove();
|
27
|
-
});
|
28
|
-
};
|
20
|
+
*/
|
29
21
|
|
30
22
|
|
31
23
|
function showSource( e ) {
|
32
24
|
var target = e.target;
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
25
|
+
while (!target.classList.contains('method-detail')) {
|
26
|
+
target = target.parentNode;
|
27
|
+
}
|
28
|
+
if (typeof target !== "undefined" && target !== null) {
|
29
|
+
target = target.querySelector('.method-source-code');
|
30
|
+
}
|
31
|
+
if (typeof target !== "undefined" && target !== null) {
|
32
|
+
target.classList.toggle('active-menu')
|
33
|
+
}
|
41
34
|
};
|
42
35
|
|
43
36
|
function hookSourceViews() {
|
44
|
-
|
37
|
+
document.querySelectorAll('.method-heading').forEach(function (codeObject) {
|
38
|
+
codeObject.addEventListener('click', showSource);
|
39
|
+
});
|
45
40
|
};
|
46
41
|
|
47
42
|
function hookSearch() {
|
48
|
-
var input =
|
49
|
-
var result =
|
50
|
-
|
43
|
+
var input = document.querySelector('#search-field');
|
44
|
+
var result = document.querySelector('#search-results');
|
45
|
+
result.classList.remove("initially-hidden");
|
51
46
|
|
52
|
-
var search_section =
|
53
|
-
|
47
|
+
var search_section = document.querySelector('#search-section');
|
48
|
+
search_section.classList.remove("initially-hidden");
|
54
49
|
|
55
50
|
var search = new Search(search_data, input, result);
|
56
51
|
|
@@ -59,7 +54,7 @@ function hookSearch() {
|
|
59
54
|
var html = '';
|
60
55
|
|
61
56
|
// TODO add relative path to <script> per-page
|
62
|
-
html += '<p class="search-match"><a href="' +
|
57
|
+
html += '<p class="search-match"><a href="' + index_rel_prefix + result.path + '">' + this.hlt(result.title);
|
63
58
|
if (result.params)
|
64
59
|
html += '<span class="params">' + result.params + '</span>';
|
65
60
|
html += '</a>';
|
@@ -77,85 +72,13 @@ function hookSearch() {
|
|
77
72
|
}
|
78
73
|
|
79
74
|
search.select = function(result) {
|
80
|
-
|
81
|
-
window.location.href = result_element.firstChild.firstChild.href;
|
75
|
+
window.location.href = result.firstChild.firstChild.href;
|
82
76
|
}
|
83
77
|
|
84
78
|
search.scrollIntoView = search.scrollInWindow;
|
85
79
|
};
|
86
80
|
|
87
|
-
function
|
88
|
-
console.debug( "Highlighting target '%s'.", anchor );
|
89
|
-
|
90
|
-
$("a[name]").each( function() {
|
91
|
-
if ( $(this).attr("name") == anchor ) {
|
92
|
-
if ( !$(this).parent().parent().hasClass('target-section') ) {
|
93
|
-
console.debug( "Wrapping the target-section" );
|
94
|
-
$('div.method-detail').unwrap( 'div.target-section' );
|
95
|
-
$(this).parent().wrap( '<div class="target-section"></div>' );
|
96
|
-
} else {
|
97
|
-
console.debug( "Already wrapped." );
|
98
|
-
}
|
99
|
-
}
|
100
|
-
});
|
101
|
-
};
|
102
|
-
|
103
|
-
function highlightLocationTarget() {
|
104
|
-
console.debug( "Location hash: %s", window.location.hash );
|
105
|
-
if ( ! window.location.hash || window.location.hash.length == 0 ) return;
|
106
|
-
|
107
|
-
var anchor = window.location.hash.substring(1);
|
108
|
-
console.debug( "Found anchor: %s; matching %s", anchor, "a[name=" + anchor + "]" );
|
109
|
-
|
110
|
-
highlightTarget( anchor );
|
111
|
-
};
|
112
|
-
|
113
|
-
function highlightClickTarget( event ) {
|
114
|
-
console.debug( "Highlighting click target for event %o", event.target );
|
115
|
-
try {
|
116
|
-
var anchor = $(event.target).attr( 'href' ).substring(1);
|
117
|
-
console.debug( "Found target anchor: %s", anchor );
|
118
|
-
highlightTarget( anchor );
|
119
|
-
} catch ( err ) {
|
120
|
-
console.error( "Exception while highlighting: %o", err );
|
121
|
-
};
|
122
|
-
};
|
123
|
-
|
124
|
-
function loadAsync(path, success) {
|
125
|
-
$.ajax({
|
126
|
-
url: rdoc_rel_prefix + path,
|
127
|
-
dataType: 'script',
|
128
|
-
success: success,
|
129
|
-
cache: true
|
130
|
-
});
|
131
|
-
};
|
132
|
-
|
133
|
-
$(document).ready( function() {
|
81
|
+
document.addEventListener('DOMContentLoaded', function() {
|
134
82
|
hookSourceViews();
|
135
|
-
|
136
|
-
$('ul.link-list a').bind( "click", highlightClickTarget );
|
137
|
-
|
138
|
-
var search_scripts_loaded = {
|
139
|
-
navigation_loaded: false,
|
140
|
-
search_loaded: false,
|
141
|
-
search_index_loaded: false,
|
142
|
-
searcher_loaded: false,
|
143
|
-
}
|
144
|
-
|
145
|
-
var search_success_function = function(variable) {
|
146
|
-
return (function (data, status, xhr) {
|
147
|
-
search_scripts_loaded[variable] = true;
|
148
|
-
|
149
|
-
if (search_scripts_loaded['navigation_loaded'] == true &&
|
150
|
-
search_scripts_loaded['search_loaded'] == true &&
|
151
|
-
search_scripts_loaded['search_index_loaded'] == true &&
|
152
|
-
search_scripts_loaded['searcher_loaded'] == true)
|
153
|
-
hookSearch();
|
154
|
-
});
|
155
|
-
}
|
156
|
-
|
157
|
-
loadAsync('js/navigation.js', search_success_function('navigation_loaded'));
|
158
|
-
loadAsync('js/search.js', search_success_function('search_loaded'));
|
159
|
-
loadAsync('js/search_index.js', search_success_function('search_index_loaded'));
|
160
|
-
loadAsync('js/searcher.js', search_success_function('searcher_loaded'));
|
83
|
+
hookSearch();
|
161
84
|
});
|
@@ -1,29 +1,29 @@
|
|
1
1
|
Search = function(data, input, result) {
|
2
2
|
this.data = data;
|
3
|
-
this
|
4
|
-
this
|
3
|
+
this.input = input;
|
4
|
+
this.result = result;
|
5
5
|
|
6
|
-
this
|
7
|
-
this
|
6
|
+
this.current = null;
|
7
|
+
this.view = this.result.parentNode;
|
8
8
|
this.searcher = new Searcher(data.index);
|
9
9
|
this.init();
|
10
10
|
}
|
11
11
|
|
12
|
-
Search.prototype =
|
12
|
+
Search.prototype = Object.assign({}, Navigation, new function() {
|
13
13
|
var suid = 1;
|
14
14
|
|
15
15
|
this.init = function() {
|
16
16
|
var _this = this;
|
17
17
|
var observer = function(e) {
|
18
|
-
switch(e.
|
18
|
+
switch(e.keyCode) {
|
19
19
|
case 38: // Event.KEY_UP
|
20
20
|
case 40: // Event.KEY_DOWN
|
21
21
|
return;
|
22
22
|
}
|
23
|
-
_this.search(_this
|
23
|
+
_this.search(_this.input.value);
|
24
24
|
};
|
25
|
-
this
|
26
|
-
this
|
25
|
+
this.input.addEventListener('keyup', observer);
|
26
|
+
this.input.addEventListener('click', observer); // mac's clear field
|
27
27
|
|
28
28
|
this.searcher.ready(function(results, isLast) {
|
29
29
|
_this.addResults(results, isLast);
|
@@ -34,7 +34,7 @@ Search.prototype = $.extend({}, Navigation, new function() {
|
|
34
34
|
}
|
35
35
|
|
36
36
|
this.search = function(value, selectFirstMatch) {
|
37
|
-
value =
|
37
|
+
value = value.trim().toLowerCase();
|
38
38
|
if (value) {
|
39
39
|
this.setNavigationActive(true);
|
40
40
|
} else {
|
@@ -43,23 +43,23 @@ Search.prototype = $.extend({}, Navigation, new function() {
|
|
43
43
|
|
44
44
|
if (value == '') {
|
45
45
|
this.lastQuery = value;
|
46
|
-
this
|
47
|
-
this
|
46
|
+
this.result.innerHTML = '';
|
47
|
+
this.result.setAttribute('aria-expanded', 'false');
|
48
48
|
this.setNavigationActive(false);
|
49
49
|
} else if (value != this.lastQuery) {
|
50
50
|
this.lastQuery = value;
|
51
|
-
this
|
52
|
-
this
|
51
|
+
this.result.setAttribute('aria-busy', 'true');
|
52
|
+
this.result.setAttribute('aria-expanded', 'true');
|
53
53
|
this.firstRun = true;
|
54
54
|
this.searcher.find(value);
|
55
55
|
}
|
56
56
|
}
|
57
57
|
|
58
58
|
this.addResults = function(results, isLast) {
|
59
|
-
var target = this
|
59
|
+
var target = this.result;
|
60
60
|
if (this.firstRun && (results.length > 0 || isLast)) {
|
61
|
-
this
|
62
|
-
this
|
61
|
+
this.current = null;
|
62
|
+
this.result.innerHTML = '';
|
63
63
|
}
|
64
64
|
|
65
65
|
for (var i=0, l = results.length; i < l; i++) {
|
@@ -70,25 +70,26 @@ Search.prototype = $.extend({}, Navigation, new function() {
|
|
70
70
|
|
71
71
|
if (this.firstRun && results.length > 0) {
|
72
72
|
this.firstRun = false;
|
73
|
-
this
|
74
|
-
this
|
73
|
+
this.current = target.firstChild;
|
74
|
+
this.current.classList.add('search-selected');
|
75
75
|
}
|
76
|
-
|
76
|
+
//TODO: ECMAScript
|
77
|
+
//if (jQuery.browser.msie) this.$element[0].className += '';
|
77
78
|
|
78
|
-
if (isLast) this
|
79
|
+
if (isLast) this.result.setAttribute('aria-busy', 'false');
|
79
80
|
}
|
80
81
|
|
81
82
|
this.move = function(isDown) {
|
82
|
-
if (!this
|
83
|
-
var
|
84
|
-
if (
|
85
|
-
this
|
86
|
-
|
87
|
-
this
|
88
|
-
this.scrollIntoView(
|
89
|
-
this
|
90
|
-
this
|
91
|
-
this
|
83
|
+
if (!this.current) return;
|
84
|
+
var next = isDown ? this.current.nextElementSibling : this.current.previousElementSibling;
|
85
|
+
if (next) {
|
86
|
+
this.current.classList.remove('search-selected');
|
87
|
+
next.classList.add('search-selected');
|
88
|
+
this.input.setAttribute('aria-activedescendant', next.getAttribute('id'));
|
89
|
+
this.scrollIntoView(next, this.view);
|
90
|
+
this.current = next;
|
91
|
+
this.input.value = next.firstChild.firstChild.text;
|
92
|
+
this.input.select();
|
92
93
|
}
|
93
94
|
return true;
|
94
95
|
}
|
@@ -19,28 +19,28 @@
|
|
19
19
|
<p>Here you can browse local documentation from the ruby standard library and
|
20
20
|
your installed gems.
|
21
21
|
|
22
|
-
|
23
|
-
|
22
|
+
<%- extra_dirs = installed.select { |_, _, _, type,| type == :extra } -%>
|
23
|
+
<%- unless extra_dirs.empty? -%>
|
24
24
|
<h2>Extra Documentation Directories</h2>
|
25
25
|
|
26
26
|
<p>The following additional documentation directories are available:</p>
|
27
27
|
|
28
28
|
<ol>
|
29
|
-
|
29
|
+
<%- extra_dirs.each do |name, href, exists, _, path| -%>
|
30
30
|
<li>
|
31
|
-
|
31
|
+
<%- if exists -%>
|
32
32
|
<a href="<%= href %>"><%= h name %></a> (<%= h path %>)
|
33
|
-
|
33
|
+
<%- else -%>
|
34
34
|
<%= h name %> (<%= h path %>; <i>not available</i>)
|
35
|
-
|
35
|
+
<%- end -%>
|
36
36
|
</li>
|
37
|
-
|
37
|
+
<%- end -%>
|
38
38
|
</ol>
|
39
|
-
|
39
|
+
<%- end -%>
|
40
40
|
|
41
|
-
|
42
|
-
|
43
|
-
|
41
|
+
<%- gems = installed.select { |_, _, _, type,| type == :gem } -%>
|
42
|
+
<%- missing = gems.reject { |_, _, exists,| exists } -%>
|
43
|
+
<%- unless missing.empty? then -%>
|
44
44
|
<h2>Missing Gem Documentation</h2>
|
45
45
|
|
46
46
|
<p>You are missing documentation for some of your installed gems.
|
@@ -53,11 +53,10 @@
|
|
53
53
|
the following commands.
|
54
54
|
|
55
55
|
<ul>
|
56
|
-
|
57
|
-
|
56
|
+
<%- names = missing.map { |name,| name.sub(/-([^-]*)$/, '') }.uniq -%>
|
57
|
+
<%- names.each do |name| -%>
|
58
58
|
<li><kbd>gem rdoc <%=h name %></kbd>
|
59
|
-
|
59
|
+
<%- end -%>
|
60
60
|
</ul>
|
61
|
-
|
61
|
+
<%- end -%>
|
62
62
|
</main>
|
63
|
-
|
@@ -2,11 +2,11 @@
|
|
2
2
|
<main role="main">
|
3
3
|
<h1 class="class"><%= h @title %></h1>
|
4
4
|
|
5
|
-
|
6
|
-
|
5
|
+
<%- simple_files = @files.select { |f| f.text? } -%>
|
6
|
+
<%- unless simple_files.empty? then -%>
|
7
7
|
<h2 id="pages">Pages</h2>
|
8
8
|
<ul>
|
9
|
-
|
9
|
+
<%- simple_files.sort.each do |file| -%>
|
10
10
|
<li class="file">
|
11
11
|
<a href="<%= file.path %>"><%= h file.page_name %></a>
|
12
12
|
<%
|
@@ -14,45 +14,45 @@
|
|
14
14
|
table = file.parse(file.comment).table_of_contents
|
15
15
|
unless table.empty? then %>
|
16
16
|
<ul>
|
17
|
-
|
17
|
+
<%- table.each do |heading| -%>
|
18
18
|
<li><a href="<%= file.path %>#<%= heading.aref %>"><%= heading.plain_html %></a>
|
19
|
-
|
19
|
+
<%- end -%>
|
20
20
|
</ul>
|
21
|
-
|
21
|
+
<%- end -%>
|
22
22
|
</li>
|
23
|
-
|
23
|
+
<%- end -%>
|
24
24
|
</ul>
|
25
|
-
|
25
|
+
<%- end -%>
|
26
26
|
|
27
27
|
<h2 id="classes">Classes and Modules</h2>
|
28
28
|
<ul>
|
29
|
-
|
29
|
+
<%- @modsort.each do |klass| -%>
|
30
30
|
<li class="<%= klass.type %>">
|
31
31
|
<a href="<%= klass.path %>"><%= klass.full_name %></a>
|
32
|
-
|
32
|
+
<%- table = []
|
33
33
|
table.concat klass.parse(klass.comment_location).table_of_contents
|
34
34
|
table.concat klass.section_contents
|
35
35
|
|
36
36
|
unless table.empty? then %>
|
37
37
|
<ul>
|
38
|
-
|
38
|
+
<%- table.each do |item| -%>
|
39
39
|
<li><a href="<%= klass.path %>#<%= item.aref %>"><%= item.plain_html %></a>
|
40
|
-
|
40
|
+
<%- end -%>
|
41
41
|
</ul>
|
42
|
-
|
42
|
+
<%- end -%>
|
43
43
|
</li>
|
44
|
-
|
44
|
+
<%- end -%>
|
45
45
|
</ul>
|
46
46
|
|
47
47
|
<h2 id="methods">Methods</h2>
|
48
48
|
<ul>
|
49
|
-
|
49
|
+
<%- @store.all_classes_and_modules.map do |mod|
|
50
50
|
mod.method_list
|
51
51
|
end.flatten.sort.each do |method| %>
|
52
52
|
<li class="method">
|
53
53
|
<a href="<%= method.path %>"><%= h method.pretty_name %></a>
|
54
54
|
—
|
55
55
|
<span class="container"><%= method.parent.full_name %></span>
|
56
|
-
|
56
|
+
<%- end -%>
|
57
57
|
</ul>
|
58
58
|
</main>
|
@@ -10,10 +10,8 @@ Navigation = new function() {
|
|
10
10
|
this.initNavigation = function() {
|
11
11
|
var _this = this;
|
12
12
|
|
13
|
-
|
13
|
+
document.addEventListener('keydown', function(e) {
|
14
14
|
_this.onkeydown(e);
|
15
|
-
}).keyup(function(e) {
|
16
|
-
_this.onkeyup(e);
|
17
15
|
});
|
18
16
|
|
19
17
|
this.navigationActive = true;
|
@@ -21,20 +19,6 @@ Navigation = new function() {
|
|
21
19
|
|
22
20
|
this.setNavigationActive = function(state) {
|
23
21
|
this.navigationActive = state;
|
24
|
-
this.clearMoveTimeout();
|
25
|
-
}
|
26
|
-
|
27
|
-
this.onkeyup = function(e) {
|
28
|
-
if (!this.navigationActive) return;
|
29
|
-
|
30
|
-
switch(e.keyCode) {
|
31
|
-
case 37: //Event.KEY_LEFT:
|
32
|
-
case 38: //Event.KEY_UP:
|
33
|
-
case 39: //Event.KEY_RIGHT:
|
34
|
-
case 40: //Event.KEY_DOWN:
|
35
|
-
this.clearMoveTimeout();
|
36
|
-
break;
|
37
|
-
}
|
38
22
|
}
|
39
23
|
|
40
24
|
this.onkeydown = function(e) {
|
@@ -46,7 +30,6 @@ Navigation = new function() {
|
|
46
30
|
case 38: //Event.KEY_UP:
|
47
31
|
if (e.keyCode == 38 || e.ctrlKey) {
|
48
32
|
if (this.moveUp()) e.preventDefault();
|
49
|
-
this.startMoveTimeout(false);
|
50
33
|
}
|
51
34
|
break;
|
52
35
|
case 39: //Event.KEY_RIGHT:
|
@@ -55,34 +38,14 @@ Navigation = new function() {
|
|
55
38
|
case 40: //Event.KEY_DOWN:
|
56
39
|
if (e.keyCode == 40 || e.ctrlKey) {
|
57
40
|
if (this.moveDown()) e.preventDefault();
|
58
|
-
this.startMoveTimeout(true);
|
59
41
|
}
|
60
42
|
break;
|
61
43
|
case 13: //Event.KEY_RETURN:
|
62
|
-
if (this
|
63
|
-
|
64
|
-
this.select(this.$current);
|
44
|
+
if (this.current) e.preventDefault();
|
45
|
+
this.select(this.current);
|
65
46
|
break;
|
66
47
|
}
|
67
|
-
if (e.ctrlKey && e.shiftKey) this.select(this
|
68
|
-
}
|
69
|
-
|
70
|
-
this.clearMoveTimeout = function() {
|
71
|
-
clearTimeout(this.moveTimeout);
|
72
|
-
this.moveTimeout = null;
|
73
|
-
}
|
74
|
-
|
75
|
-
this.startMoveTimeout = function(isDown) {
|
76
|
-
if (!$.browser.mozilla && !$.browser.opera) return;
|
77
|
-
if (this.moveTimeout) this.clearMoveTimeout();
|
78
|
-
var _this = this;
|
79
|
-
|
80
|
-
var go = function() {
|
81
|
-
if (!_this.moveTimeout) return;
|
82
|
-
_this[isDown ? 'moveDown' : 'moveUp']();
|
83
|
-
_this.moveTimout = setTimeout(go, 100);
|
84
|
-
}
|
85
|
-
this.moveTimeout = setTimeout(go, 200);
|
48
|
+
if (e.ctrlKey && e.shiftKey) this.select(this.current);
|
86
49
|
}
|
87
50
|
|
88
51
|
this.moveRight = function() {
|
@@ -51,20 +51,20 @@ Searcher.prototype = new function() {
|
|
51
51
|
|
52
52
|
/* ----- Utilities ------ */
|
53
53
|
function splitQuery(query) {
|
54
|
-
return
|
54
|
+
return query.split(/(\s+|::?|\(\)?)/).filter(function(string) {
|
55
55
|
return string.match(/\S/);
|
56
56
|
});
|
57
57
|
}
|
58
58
|
|
59
59
|
function buildRegexps(queries) {
|
60
|
-
return
|
60
|
+
return queries.map(function(query) {
|
61
61
|
return new RegExp(query.replace(/(.)/g, '([$1])([^$1]*?)'), 'i');
|
62
62
|
});
|
63
63
|
}
|
64
64
|
|
65
65
|
function buildHilighters(queries) {
|
66
|
-
return
|
67
|
-
return
|
66
|
+
return queries.map(function(query) {
|
67
|
+
return query.split('').map(function(l, i) {
|
68
68
|
return '\u0001$' + (i*2+1) + '\u0002$' + (i*2+2);
|
69
69
|
}).join('');
|
70
70
|
});
|
@@ -172,6 +172,7 @@ Searcher.prototype = new function() {
|
|
172
172
|
result.path = info[2];
|
173
173
|
result.params = info[3];
|
174
174
|
result.snippet = info[4];
|
175
|
+
result.badge = info[6];
|
175
176
|
return result;
|
176
177
|
}
|
177
178
|
|
@@ -220,9 +221,9 @@ Searcher.prototype = new function() {
|
|
220
221
|
}
|
221
222
|
|
222
223
|
function triggerResults(results, isLast) {
|
223
|
-
|
224
|
+
this.handlers.forEach(function(fn) {
|
224
225
|
fn.call(this, results, isLast)
|
225
|
-
})
|
226
|
+
});
|
226
227
|
}
|
227
228
|
}
|
228
229
|
|
data/lib/rdoc/generator.rb
CHANGED
@@ -1,3 +1,4 @@
|
|
1
|
+
# frozen_string_literal: true
|
1
2
|
##
|
2
3
|
# RDoc uses generators to turn parsed source code in the form of an
|
3
4
|
# RDoc::CodeObject tree into some form of output. RDoc comes with the HTML
|
@@ -48,4 +49,3 @@ module RDoc::Generator
|
|
48
49
|
autoload :POT, 'rdoc/generator/pot'
|
49
50
|
|
50
51
|
end
|
51
|
-
|
data/lib/rdoc/ghost_method.rb
CHANGED
data/lib/rdoc/i18n/locale.rb
CHANGED
@@ -1,3 +1,4 @@
|
|
1
|
+
# frozen_string_literal: true
|
1
2
|
##
|
2
3
|
# A message container for a locale.
|
3
4
|
#
|
@@ -91,7 +92,7 @@ class RDoc::I18n::Locale
|
|
91
92
|
end
|
92
93
|
|
93
94
|
##
|
94
|
-
# Translates the +message+ into locale. If there is no
|
95
|
+
# Translates the +message+ into locale. If there is no translation
|
95
96
|
# messages for +message+ in locale, +message+ itself is returned.
|
96
97
|
|
97
98
|
def translate(message)
|
data/lib/rdoc/i18n/text.rb
CHANGED
@@ -1,3 +1,4 @@
|
|
1
|
+
# frozen_string_literal: true
|
1
2
|
##
|
2
3
|
# An i18n supported text.
|
3
4
|
#
|
@@ -45,9 +46,9 @@ class RDoc::I18n::Text
|
|
45
46
|
parse do |part|
|
46
47
|
case part[:type]
|
47
48
|
when :paragraph
|
48
|
-
translated_text
|
49
|
+
translated_text += locale.translate(part[:paragraph])
|
49
50
|
when :empty_line
|
50
|
-
translated_text
|
51
|
+
translated_text += part[:line]
|
51
52
|
else
|
52
53
|
raise "should not reach here: unexpected type: #{type}"
|
53
54
|
end
|
@@ -68,14 +69,14 @@ class RDoc::I18n::Text
|
|
68
69
|
if paragraph.empty?
|
69
70
|
emit_empty_line_event(line, line_no, &block)
|
70
71
|
else
|
71
|
-
paragraph
|
72
|
+
paragraph += line
|
72
73
|
emit_paragraph_event(paragraph, paragraph_start_line, line_no,
|
73
74
|
&block)
|
74
75
|
paragraph = ''
|
75
76
|
end
|
76
77
|
else
|
77
78
|
paragraph_start_line = line_no if paragraph.empty?
|
78
|
-
paragraph
|
79
|
+
paragraph += line
|
79
80
|
end
|
80
81
|
end
|
81
82
|
|
data/lib/rdoc/i18n.rb
CHANGED
@@ -1,9 +1,10 @@
|
|
1
|
+
# frozen_string_literal: true
|
1
2
|
##
|
2
|
-
# This module provides i18n
|
3
|
+
# This module provides i18n related features.
|
3
4
|
|
4
5
|
module RDoc::I18n
|
5
6
|
|
6
7
|
autoload :Locale, 'rdoc/i18n/locale'
|
7
|
-
|
8
|
+
require_relative 'i18n/text'
|
8
9
|
|
9
10
|
end
|
data/lib/rdoc/include.rb
CHANGED
data/lib/rdoc/known_classes.rb
CHANGED
@@ -1,4 +1,5 @@
|
|
1
1
|
# coding: UTF-8
|
2
|
+
# frozen_string_literal: true
|
2
3
|
# :markup: markdown
|
3
4
|
|
4
5
|
##
|
@@ -288,8 +289,6 @@ class RDoc::Markdown::Literals
|
|
288
289
|
else
|
289
290
|
return ans
|
290
291
|
end
|
291
|
-
|
292
|
-
return ans
|
293
292
|
end
|
294
293
|
end
|
295
294
|
|
@@ -322,8 +321,6 @@ class RDoc::Markdown::Literals
|
|
322
321
|
else
|
323
322
|
return ans
|
324
323
|
end
|
325
|
-
|
326
|
-
return ans
|
327
324
|
end
|
328
325
|
end
|
329
326
|
|