yard 0.9.38 → 0.9.40
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +27 -1
- data/README.md +18 -21
- data/docs/GettingStarted.md +41 -15
- data/docs/Tags.md +5 -5
- data/docs/WhatsNew.md +59 -7
- data/docs/templates/default/yard_tags/html/setup.rb +1 -1
- data/lib/yard/autoload.rb +17 -0
- data/lib/yard/cli/diff.rb +7 -2
- data/lib/yard/code_objects/proxy.rb +1 -1
- data/lib/yard/handlers/processor.rb +1 -0
- data/lib/yard/handlers/rbs/attribute_handler.rb +43 -0
- data/lib/yard/handlers/rbs/base.rb +38 -0
- data/lib/yard/handlers/rbs/constant_handler.rb +18 -0
- data/lib/yard/handlers/rbs/method_handler.rb +327 -0
- data/lib/yard/handlers/rbs/mixin_handler.rb +20 -0
- data/lib/yard/handlers/rbs/namespace_handler.rb +26 -0
- data/lib/yard/handlers/ruby/attribute_handler.rb +7 -4
- data/lib/yard/handlers/ruby/constant_handler.rb +1 -0
- data/lib/yard/i18n/locale.rb +1 -1
- data/lib/yard/i18n/pot_generator.rb +1 -1
- data/lib/yard/parser/rbs/rbs_parser.rb +325 -0
- data/lib/yard/parser/rbs/statement.rb +75 -0
- data/lib/yard/parser/ruby/legacy/irb/slex.rb +19 -1
- data/lib/yard/parser/ruby/ruby_parser.rb +55 -3
- data/lib/yard/parser/source_parser.rb +3 -2
- data/lib/yard/registry_resolver.rb +7 -0
- data/lib/yard/rubygems/specification.rb +1 -1
- data/lib/yard/server/library_version.rb +1 -1
- data/lib/yard/server/templates/default/fulldoc/html/js/autocomplete.js +208 -12
- data/lib/yard/server/templates/default/layout/html/breadcrumb.erb +1 -17
- data/lib/yard/server/templates/default/method_details/html/permalink.erb +4 -2
- data/lib/yard/server/templates/doc_server/library_list/html/headers.erb +3 -3
- data/lib/yard/server/templates/doc_server/library_list/html/library_list.erb +2 -3
- data/lib/yard/server/templates/doc_server/processing/html/processing.erb +22 -16
- data/lib/yard/tags/directives.rb +7 -0
- data/lib/yard/tags/library.rb +3 -3
- data/lib/yard/tags/types_explainer.rb +2 -1
- data/lib/yard/templates/helpers/base_helper.rb +1 -1
- data/lib/yard/templates/helpers/html_helper.rb +16 -5
- data/lib/yard/templates/helpers/html_syntax_highlight_helper.rb +6 -1
- data/lib/yard/templates/helpers/markup/hybrid_markdown.rb +2125 -0
- data/lib/yard/templates/helpers/markup_helper.rb +4 -2
- data/lib/yard/version.rb +1 -1
- data/po/ja.po +82 -82
- data/templates/default/fulldoc/html/full_list.erb +4 -4
- data/templates/default/fulldoc/html/js/app.js +503 -319
- data/templates/default/fulldoc/html/js/full_list.js +310 -212
- data/templates/default/layout/html/headers.erb +1 -1
- data/templates/default/method/html/header.erb +3 -3
- data/templates/default/module/html/defines.erb +3 -3
- data/templates/default/module/html/inherited_methods.erb +1 -0
- data/templates/default/module/html/method_summary.erb +8 -0
- data/templates/default/module/setup.rb +20 -0
- data/templates/default/onefile/html/layout.erb +3 -4
- data/templates/guide/fulldoc/html/js/app.js +57 -26
- data/templates/guide/layout/html/layout.erb +9 -11
- metadata +14 -4
|
@@ -1,12 +1,208 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
1
|
+
(function() {
|
|
2
|
+
function query(selector, root) {
|
|
3
|
+
return (root || document).querySelector(selector);
|
|
4
|
+
}
|
|
5
|
+
|
|
6
|
+
function ready(callback) {
|
|
7
|
+
if (document.readyState === "loading") {
|
|
8
|
+
document.addEventListener("DOMContentLoaded", callback, { once: true });
|
|
9
|
+
} else {
|
|
10
|
+
callback();
|
|
11
|
+
}
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
function createAutocomplete(input) {
|
|
15
|
+
var form = input.form;
|
|
16
|
+
var results = document.createElement("div");
|
|
17
|
+
var list = document.createElement("ul");
|
|
18
|
+
var requestTimer = null;
|
|
19
|
+
var controller = null;
|
|
20
|
+
var items = [];
|
|
21
|
+
var activeIndex = -1;
|
|
22
|
+
var blurTimer = null;
|
|
23
|
+
|
|
24
|
+
if (!form) return;
|
|
25
|
+
|
|
26
|
+
results.className = "ac_results";
|
|
27
|
+
results.hidden = true;
|
|
28
|
+
results.setAttribute("role", "listbox");
|
|
29
|
+
results.id = input.id + "_results";
|
|
30
|
+
list.setAttribute("role", "presentation");
|
|
31
|
+
results.appendChild(list);
|
|
32
|
+
input.setAttribute("autocomplete", "off");
|
|
33
|
+
input.setAttribute("aria-autocomplete", "list");
|
|
34
|
+
input.setAttribute("aria-controls", results.id);
|
|
35
|
+
input.setAttribute("aria-expanded", "false");
|
|
36
|
+
form.appendChild(results);
|
|
37
|
+
|
|
38
|
+
function syncResultsWidth() {
|
|
39
|
+
results.style.width = input.offsetWidth + "px";
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
function hideResults() {
|
|
43
|
+
results.hidden = true;
|
|
44
|
+
input.setAttribute("aria-expanded", "false");
|
|
45
|
+
input.removeAttribute("aria-activedescendant");
|
|
46
|
+
activeIndex = -1;
|
|
47
|
+
items = [];
|
|
48
|
+
list.innerHTML = "";
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
function setActive(index) {
|
|
52
|
+
if (!items.length) return;
|
|
53
|
+
activeIndex = (index + items.length) % items.length;
|
|
54
|
+
items.forEach(function(item, itemIndex) {
|
|
55
|
+
item.element.classList.toggle("ac_over", itemIndex === activeIndex);
|
|
56
|
+
});
|
|
57
|
+
input.setAttribute("aria-activedescendant", items[activeIndex].element.id);
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
function selectItem(item) {
|
|
61
|
+
input.value = item.values[1];
|
|
62
|
+
window.location.href = item.values[3];
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
function renderItems(lines) {
|
|
66
|
+
syncResultsWidth();
|
|
67
|
+
list.innerHTML = "";
|
|
68
|
+
items = lines.map(function(line, index) {
|
|
69
|
+
var values = line.split(",");
|
|
70
|
+
var element = document.createElement("li");
|
|
71
|
+
var label = document.createElement("span");
|
|
72
|
+
var namespace = document.createElement("small");
|
|
73
|
+
|
|
74
|
+
element.id = results.id + "_item_" + index;
|
|
75
|
+
element.setAttribute("role", "option");
|
|
76
|
+
element.className = index % 2 === 0 ? "ac_even" : "ac_odd";
|
|
77
|
+
label.textContent = values[0];
|
|
78
|
+
element.appendChild(label);
|
|
79
|
+
|
|
80
|
+
if (values[1] !== "") {
|
|
81
|
+
namespace.textContent = "(" + values[1] + ")";
|
|
82
|
+
element.appendChild(document.createTextNode(" "));
|
|
83
|
+
element.appendChild(namespace);
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
element.addEventListener("mouseenter", function() {
|
|
87
|
+
setActive(index);
|
|
88
|
+
});
|
|
89
|
+
element.addEventListener("mousedown", function(event) {
|
|
90
|
+
event.preventDefault();
|
|
91
|
+
selectItem(items[index]);
|
|
92
|
+
});
|
|
93
|
+
|
|
94
|
+
list.appendChild(element);
|
|
95
|
+
|
|
96
|
+
return { element: element, values: values };
|
|
97
|
+
});
|
|
98
|
+
|
|
99
|
+
if (items.length) {
|
|
100
|
+
results.hidden = false;
|
|
101
|
+
input.setAttribute("aria-expanded", "true");
|
|
102
|
+
setActive(0);
|
|
103
|
+
} else {
|
|
104
|
+
hideResults();
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
function fetchResults(term) {
|
|
109
|
+
if (controller) controller.abort();
|
|
110
|
+
controller = new AbortController();
|
|
111
|
+
input.classList.add("ac_loading");
|
|
112
|
+
|
|
113
|
+
fetch(
|
|
114
|
+
form.action +
|
|
115
|
+
"?q=" +
|
|
116
|
+
encodeURIComponent(term) +
|
|
117
|
+
"&_=" +
|
|
118
|
+
new Date().getTime(),
|
|
119
|
+
{
|
|
120
|
+
headers: {
|
|
121
|
+
"X-Requested-With": "XMLHttpRequest"
|
|
122
|
+
},
|
|
123
|
+
signal: controller.signal
|
|
124
|
+
}
|
|
125
|
+
)
|
|
126
|
+
.then(function(response) {
|
|
127
|
+
return response.text();
|
|
128
|
+
})
|
|
129
|
+
.then(function(text) {
|
|
130
|
+
var lines = text
|
|
131
|
+
.split("\n")
|
|
132
|
+
.map(function(line) {
|
|
133
|
+
return line.trim();
|
|
134
|
+
})
|
|
135
|
+
.filter(Boolean);
|
|
136
|
+
|
|
137
|
+
renderItems(lines);
|
|
138
|
+
})
|
|
139
|
+
.catch(function(error) {
|
|
140
|
+
if (error.name !== "AbortError") hideResults();
|
|
141
|
+
})
|
|
142
|
+
.finally(function() {
|
|
143
|
+
input.classList.remove("ac_loading");
|
|
144
|
+
});
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
input.addEventListener("input", function() {
|
|
148
|
+
clearTimeout(requestTimer);
|
|
149
|
+
if (blurTimer) clearTimeout(blurTimer);
|
|
150
|
+
|
|
151
|
+
if (!input.value.trim()) {
|
|
152
|
+
hideResults();
|
|
153
|
+
return;
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
requestTimer = setTimeout(function() {
|
|
157
|
+
fetchResults(input.value.trim());
|
|
158
|
+
}, 200);
|
|
159
|
+
});
|
|
160
|
+
|
|
161
|
+
input.addEventListener("keydown", function(event) {
|
|
162
|
+
if (results.hidden && (event.key === "ArrowDown" || event.key === "ArrowUp")) {
|
|
163
|
+
if (!input.value.trim()) return;
|
|
164
|
+
fetchResults(input.value.trim());
|
|
165
|
+
return;
|
|
166
|
+
}
|
|
167
|
+
|
|
168
|
+
if (event.key === "ArrowDown") {
|
|
169
|
+
event.preventDefault();
|
|
170
|
+
setActive(activeIndex + 1);
|
|
171
|
+
} else if (event.key === "ArrowUp") {
|
|
172
|
+
event.preventDefault();
|
|
173
|
+
setActive(activeIndex - 1);
|
|
174
|
+
} else if (event.key === "Enter") {
|
|
175
|
+
if (activeIndex >= 0 && items[activeIndex]) {
|
|
176
|
+
event.preventDefault();
|
|
177
|
+
selectItem(items[activeIndex]);
|
|
178
|
+
}
|
|
179
|
+
} else if (event.key === "Escape") {
|
|
180
|
+
hideResults();
|
|
181
|
+
}
|
|
182
|
+
});
|
|
183
|
+
|
|
184
|
+
input.addEventListener("blur", function() {
|
|
185
|
+
blurTimer = setTimeout(hideResults, 150);
|
|
186
|
+
});
|
|
187
|
+
|
|
188
|
+
input.addEventListener("focus", function() {
|
|
189
|
+
syncResultsWidth();
|
|
190
|
+
if (items.length) {
|
|
191
|
+
results.hidden = false;
|
|
192
|
+
input.setAttribute("aria-expanded", "true");
|
|
193
|
+
}
|
|
194
|
+
});
|
|
195
|
+
|
|
196
|
+
document.addEventListener("click", function(event) {
|
|
197
|
+
if (!form.contains(event.target)) hideResults();
|
|
198
|
+
});
|
|
199
|
+
|
|
200
|
+
window.addEventListener("resize", syncResultsWidth);
|
|
201
|
+
syncResultsWidth();
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
ready(function() {
|
|
205
|
+
var input = query("#search_box");
|
|
206
|
+
if (input) createAutocomplete(input);
|
|
207
|
+
});
|
|
208
|
+
})();
|
|
@@ -1,22 +1,6 @@
|
|
|
1
1
|
<form class="search" method="get" action="<%= abs_url base_path(router.search_prefix) %>">
|
|
2
|
-
<input name="q" type="search" placeholder="Search" id="search_box" size="30" value="<%= h @query %>"
|
|
2
|
+
<input name="q" type="search" placeholder="Search" id="search_box" size="30" value="<%= h @query %>">
|
|
3
3
|
</form>
|
|
4
|
-
<script type="text/javascript" charset="utf-8">
|
|
5
|
-
$(function() {
|
|
6
|
-
$('#search_box').autocomplete($('#search_box').parent().attr('action'), {
|
|
7
|
-
width: 200,
|
|
8
|
-
formatItem: function(item) {
|
|
9
|
-
var values = item[0].split(",");
|
|
10
|
-
return values[0] + (values[1] == '' ? "" : " <small>(" + values[1] + ")</small>");
|
|
11
|
-
}
|
|
12
|
-
}).result(function(event, item) {
|
|
13
|
-
var values = item[0].split(",")
|
|
14
|
-
$('#search_box').val(values[1]);
|
|
15
|
-
location.href = values[3];
|
|
16
|
-
return false;
|
|
17
|
-
});
|
|
18
|
-
});
|
|
19
|
-
</script>
|
|
20
4
|
|
|
21
5
|
<div id="menu">
|
|
22
6
|
<% unless @single_library %>
|
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
<script>
|
|
2
|
-
|
|
3
|
-
|
|
2
|
+
document.getElementById("<%= anchor_for(object) %>").insertAdjacentHTML(
|
|
3
|
+
"afterbegin",
|
|
4
|
+
'<a class="permalink" href="<%= abs_url base_path(router.docs_prefix) %>/<%= urlencode serializer.serialized_path(object) %>">permalink</a>'
|
|
5
|
+
);
|
|
4
6
|
</script>
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
<meta
|
|
1
|
+
<meta charset="UTF-8">
|
|
2
2
|
<title>YARD Documentation Server <%= YARD::VERSION %> - Library Listing</title>
|
|
3
|
-
<link rel="stylesheet" href="<%= abs_url('css', 'style.css') %>?<%= mtime('css/style.css') %>" type="text/css" media="screen" charset="utf-8"
|
|
4
|
-
<link rel="stylesheet" href="<%= abs_url('css', 'custom.css') %>?<%= mtime('css/custom.css') %>" type="text/css" media="screen" charset="utf-8"
|
|
3
|
+
<link rel="stylesheet" href="<%= abs_url('css', 'style.css') %>?<%= mtime('css/style.css') %>" type="text/css" media="screen" charset="utf-8">
|
|
4
|
+
<link rel="stylesheet" href="<%= abs_url('css', 'custom.css') %>?<%= mtime('css/custom.css') %>" type="text/css" media="screen" charset="utf-8">
|
|
5
5
|
<style type="text/css" media="screen">
|
|
6
6
|
ul { list-style: circle inside none; padding: 0; }
|
|
7
7
|
li { font-size: 1.2em; line-height: 1.4em; padding: 3px 5px; }
|
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
<!DOCTYPE html
|
|
2
|
-
|
|
3
|
-
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
4
3
|
<head>
|
|
5
4
|
<%= erb(:headers) %>
|
|
6
5
|
</head>
|
|
@@ -2,29 +2,35 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8">
|
|
5
|
-
<link rel="stylesheet" href="<%= abs_url('css', 'style.css') %>?<%= mtime('css/style.css') %>" type="text/css" media="screen" charset="utf-8"
|
|
6
|
-
<link rel="stylesheet" href="<%= abs_url('css', 'custom.css') %>?<%= mtime('css/custom.css') %>" type="text/css" media="screen" charset="utf-8"
|
|
7
|
-
<script type="text/javascript" charset="utf-8" src="<%= abs_url('js', 'jquery.js') %>?<%= mtime('js/jquery.js') %>"></script>
|
|
5
|
+
<link rel="stylesheet" href="<%= abs_url('css', 'style.css') %>?<%= mtime('css/style.css') %>" type="text/css" media="screen" charset="utf-8">
|
|
6
|
+
<link rel="stylesheet" href="<%= abs_url('css', 'custom.css') %>?<%= mtime('css/custom.css') %>" type="text/css" media="screen" charset="utf-8">
|
|
8
7
|
<script type="text/javascript" charset="utf-8">
|
|
9
8
|
function checkPage(process) {
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
9
|
+
fetch("<%= router.request.path %>" + (process ? "?process=true" : ""), { cache: "no-store" })
|
|
10
|
+
.then(function(response) {
|
|
11
|
+
if (response.status === 200) window.location.reload();
|
|
12
|
+
});
|
|
13
|
+
setTimeout(checkPage, 2000);
|
|
13
14
|
}
|
|
14
15
|
function setFade() {
|
|
15
16
|
centerMessage();
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
17
|
+
window.addEventListener("resize", centerMessage);
|
|
18
|
+
document.getElementById('fade').style.display = 'block';
|
|
19
|
+
document.getElementById('processing').style.display = 'block';
|
|
19
20
|
}
|
|
20
21
|
function centerMessage() {
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
22
|
+
var fade = document.getElementById('fade');
|
|
23
|
+
var processing = document.getElementById('processing');
|
|
24
|
+
var fadeTop = parseInt(window.getComputedStyle(fade).top, 10) || 0;
|
|
25
|
+
fade.style.width = window.innerWidth + 'px';
|
|
26
|
+
fade.style.height = (window.innerHeight - fadeTop) + 'px';
|
|
27
|
+
processing.style.left = (window.innerWidth / 2 - processing.offsetWidth / 2) + 'px';
|
|
28
|
+
processing.style.top = (window.innerHeight / 2 - processing.offsetHeight / 2) + 'px';
|
|
25
29
|
}
|
|
26
|
-
|
|
27
|
-
|
|
30
|
+
document.addEventListener("DOMContentLoaded", function() {
|
|
31
|
+
checkPage(true);
|
|
32
|
+
setFade();
|
|
33
|
+
});
|
|
28
34
|
</script>
|
|
29
35
|
<style type="text/css" media="screen">
|
|
30
36
|
body { overflow: hidden; margin: 12px; display: block; }
|
|
@@ -46,7 +52,7 @@
|
|
|
46
52
|
<strong><%= @library.name %></strong> <% if @library.version %>(<%= @library.version %>)<% end %> is being processed.
|
|
47
53
|
You'll be redirected when the pages are built, it shouldn't take much longer.
|
|
48
54
|
</p>
|
|
49
|
-
<img src="<%= abs_url('images', 'processing.gif') %>?<%= mtime('images/processing.gif') %>" align="center"
|
|
55
|
+
<img src="<%= abs_url('images', 'processing.gif') %>?<%= mtime('images/processing.gif') %>" align="center">
|
|
50
56
|
</div>
|
|
51
57
|
</body>
|
|
52
58
|
</html>
|
data/lib/yard/tags/directives.rb
CHANGED
|
@@ -543,6 +543,7 @@ module YARD
|
|
|
543
543
|
# @since 0.8.0
|
|
544
544
|
class ParseDirective < Directive
|
|
545
545
|
def call
|
|
546
|
+
existing = YARD::Registry.all.lazy.map(&:path).to_set if handler
|
|
546
547
|
lang = tag.types ? tag.types.first.to_sym :
|
|
547
548
|
(handler ? handler.parser.parser_type : :ruby)
|
|
548
549
|
if handler && lang == handler.parser.parser_type
|
|
@@ -555,6 +556,12 @@ module YARD
|
|
|
555
556
|
src_parser.file = handler.parser.file if handler
|
|
556
557
|
src_parser.parse(StringIO.new(tag.text))
|
|
557
558
|
end
|
|
559
|
+
return unless handler
|
|
560
|
+
YARD::Registry.all.each do |obj|
|
|
561
|
+
next if existing.include? obj.path
|
|
562
|
+
obj.files.each { |entry| entry[1] = handler.statement.line if entry[0] == handler.parser.file.to_s }
|
|
563
|
+
obj.source = handler.statement.source
|
|
564
|
+
end
|
|
558
565
|
end
|
|
559
566
|
end
|
|
560
567
|
|
data/lib/yard/tags/library.rb
CHANGED
|
@@ -507,7 +507,7 @@ module YARD
|
|
|
507
507
|
#
|
|
508
508
|
# @example
|
|
509
509
|
# # Synchronizes system time using NTP.
|
|
510
|
-
# # @see
|
|
510
|
+
# # @see https://ntp.org/documentation.html NTP Documentation
|
|
511
511
|
# # @see NTPHelperMethods
|
|
512
512
|
# class NTPUpdater; end
|
|
513
513
|
define_tag "See Also", :see, :with_name
|
|
@@ -541,7 +541,7 @@ module YARD
|
|
|
541
541
|
# @example
|
|
542
542
|
# # @todo Add support for Jabberwocky service.
|
|
543
543
|
# # There is an open source Jabberwocky library available
|
|
544
|
-
# # at
|
|
544
|
+
# # at https://jbrwcky.org that can be easily integrated.
|
|
545
545
|
# class Wonderlander; end
|
|
546
546
|
# @see tag:note
|
|
547
547
|
define_tag "Todo Item", :todo
|
|
@@ -554,7 +554,7 @@ module YARD
|
|
|
554
554
|
# of a specific object.
|
|
555
555
|
#
|
|
556
556
|
# @example
|
|
557
|
-
# # The public REST API for
|
|
557
|
+
# # The public REST API for https://jbrwcky.org
|
|
558
558
|
# # @version 2.0
|
|
559
559
|
# class JabberwockyAPI; end
|
|
560
560
|
define_tag "Version", :version
|
|
@@ -102,6 +102,7 @@ module YARD
|
|
|
102
102
|
:fixed_collection_start => /\(/,
|
|
103
103
|
:fixed_collection_end => /\)/,
|
|
104
104
|
:type_name => /#{ISEP}#{METHODNAMEMATCH}|#{NAMESPACEMATCH}|\w+/,
|
|
105
|
+
:symbol => /:#{METHODNAMEMATCH}/,
|
|
105
106
|
:type_next => /[,;]/,
|
|
106
107
|
:whitespace => /\s+/,
|
|
107
108
|
:hash_collection_start => /\{/,
|
|
@@ -130,7 +131,7 @@ module YARD
|
|
|
130
131
|
next unless (match.nil? && @scanner.eos?) || (match && token = @scanner.scan(match))
|
|
131
132
|
found = true
|
|
132
133
|
case token_type
|
|
133
|
-
when :type_name
|
|
134
|
+
when :type_name, :symbol
|
|
134
135
|
raise SyntaxError, "expecting END, got name '#{token}'" if name
|
|
135
136
|
name = token
|
|
136
137
|
when :type_next
|
|
@@ -45,7 +45,7 @@ module YARD::Templates::Helpers
|
|
|
45
45
|
# method depending on the arguments passed in.
|
|
46
46
|
#
|
|
47
47
|
# @example Linking a URL
|
|
48
|
-
# linkify('
|
|
48
|
+
# linkify('https://example.com')
|
|
49
49
|
# @example Including docstring contents of an object
|
|
50
50
|
# linkify('include:YARD::Docstring')
|
|
51
51
|
# @example Linking to an extra file
|
|
@@ -93,10 +93,16 @@ module YARD
|
|
|
93
93
|
:tables,
|
|
94
94
|
:with_toc_data,
|
|
95
95
|
:no_intraemphasis).to_html
|
|
96
|
+
when 'Commonmarker'
|
|
97
|
+
provider.to_html(text, :options => { }, :plugins => { :syntax_highlighter => nil })
|
|
96
98
|
when 'CommonMarker'
|
|
97
|
-
|
|
99
|
+
provider.render_html(text, %i[DEFAULT GITHUB_PRE_LANG], %i[autolink table])
|
|
98
100
|
else
|
|
99
|
-
provider.
|
|
101
|
+
if provider.respond_to?(:to_html)
|
|
102
|
+
provider.to_html(text)
|
|
103
|
+
else
|
|
104
|
+
provider.new(text).to_html
|
|
105
|
+
end
|
|
100
106
|
end
|
|
101
107
|
end
|
|
102
108
|
|
|
@@ -156,7 +162,7 @@ module YARD
|
|
|
156
162
|
# @return [String] the output HTML
|
|
157
163
|
# @since 0.6.0
|
|
158
164
|
def html_markup_text(text)
|
|
159
|
-
h(text).gsub(/\r?\n/, '<br
|
|
165
|
+
h(text).gsub(/\r?\n/, '<br>')
|
|
160
166
|
end
|
|
161
167
|
|
|
162
168
|
# @return [String] the same text with no markup
|
|
@@ -228,7 +234,7 @@ module YARD
|
|
|
228
234
|
# @return [String] HTML with linkified references
|
|
229
235
|
def resolve_links(text)
|
|
230
236
|
code_tags = 0
|
|
231
|
-
text.gsub(%r{<(/)?(pre|code|tt)|(\\|!)?\{(?!\})(\S+?)(?:\s([^\}]*?\S))?\}(
|
|
237
|
+
text.gsub(%r{<(/)?(pre|code|tt)|(\\|!)?\{(?!\})(\S+?)(?:\s([^\}]*?\S))?\}(?=\W|.+</|$)}m) do |str|
|
|
232
238
|
closed = $1
|
|
233
239
|
tag = $2
|
|
234
240
|
escape = $3
|
|
@@ -650,7 +656,12 @@ module YARD
|
|
|
650
656
|
language ||= detect_lang_in_codeblock_attributes($1, $2)
|
|
651
657
|
language ||= object.source_type
|
|
652
658
|
|
|
653
|
-
if
|
|
659
|
+
# Skip re-highlighting if the block is already highlighted (e.g. from a recursive
|
|
660
|
+
# htmlify call via {include:} or {yard:include_tags}). Passing pre-highlighted HTML
|
|
661
|
+
# through CGI.unescapeHTML would corrupt deliberately-escaped entities inside spans.
|
|
662
|
+
# Note: this heuristic suppresses highlighting for code blocks in :html markup that
|
|
663
|
+
# contain a literal <span> tag in the source being documented (an uncommon edge case).
|
|
664
|
+
if options.highlight && string !~ HtmlSyntaxHighlightHelper::ALREADY_HIGHLIGHTED_RE
|
|
654
665
|
string = html_syntax_highlight(CGI.unescapeHTML(string), language)
|
|
655
666
|
end
|
|
656
667
|
classes = ['code', language].compact.join(' ')
|
|
@@ -6,6 +6,11 @@ module YARD
|
|
|
6
6
|
module HtmlSyntaxHighlightHelper
|
|
7
7
|
include ModuleHelper
|
|
8
8
|
|
|
9
|
+
# Matches source that has already been highlighted (i.e. contains a span tag).
|
|
10
|
+
# Used to avoid double-processing pre-highlighted HTML in the rescue clause of
|
|
11
|
+
# {#html_syntax_highlight_ruby_ripper} and in the {HtmlHelper#parse_codeblocks} guard.
|
|
12
|
+
ALREADY_HIGHLIGHTED_RE = /<span[\s>]/
|
|
13
|
+
|
|
9
14
|
# Highlights Ruby source
|
|
10
15
|
# @param [String] source the Ruby source code
|
|
11
16
|
# @return [String] the highlighted Ruby source
|
|
@@ -39,7 +44,7 @@ module YARD
|
|
|
39
44
|
end
|
|
40
45
|
output
|
|
41
46
|
rescue Parser::ParserSyntaxError
|
|
42
|
-
source =~
|
|
47
|
+
source =~ ALREADY_HIGHLIGHTED_RE ? source : h(source)
|
|
43
48
|
end
|
|
44
49
|
|
|
45
50
|
def html_syntax_highlight_ruby_legacy(source)
|