This repository has been archived by the owner on Jun 7, 2024. It is now read-only.
forked from speced/respec
-
Notifications
You must be signed in to change notification settings - Fork 0
/
utils.js
307 lines (285 loc) · 14.6 KB
/
utils.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
/*global respecEvents */
// Module core/utils
// As the name implies, this contains a ragtag gang of methods that just don't fit
// anywhere else.
define(
["jquery"],
function ($) {
// --- JQUERY EXTRAS -----------------------------------------------------------------------
// Applies to any jQuery object containing elements, changes their name to the one give, and
// return a jQuery object containing the new elements
$.fn.renameElement = function (name) {
var arr = [];
this.each(function () {
var $newEl = $(this.ownerDocument.createElement(name));
// I forget why this didn't work, maybe try again
// $newEl.attr($(this).attr());
for (var i = 0, n = this.attributes.length; i < n; i++) {
var at = this.attributes[i];
$newEl[0].setAttributeNS(at.namespaceURI, at.name, at.value);
}
$(this).contents().appendTo($newEl);
$(this).replaceWith($newEl);
arr.push($newEl[0]);
});
return $(arr);
};
// For any element, returns an array of title strings that applies
// the algorithm used for determining the
// actual title of a <dfn> element (but can apply to other as well).
//
// if args.isDefinition is true, then the element is a definition, not a
// reference to a definition. Any @title or @lt will be replaced with
// @data-lt to be consistent with Bikeshed / Shepherd.
//
// This method now *prefers* the data-lt attribute for the list of
// titles. That attribute is added by this method to dfn elements, so
// subsequent calls to this method will return the data-lt based list.
//
// This method will publish a warning if a title is used on a definition
// instead of an @lt (as per specprod mailing list discussion).
$.fn.getDfnTitles = function ( args ) {
var titles = [];
var theAttr = "";
var titleString = "";
var normalizedTextContent = utils.normalizeString(this.text());
// allow @lt to be consistent with bikeshed
if (this.attr("data-lt") || this.attr("lt")) {
theAttr = this.attr("data-lt") ? "data-lt" : "lt";
// prefer @data-lt for the list of title aliases
titleString = this.attr(theAttr);
// Use the definition itself as first item, so to avoid
// having to declare the definition twice.
if(!this.attr(theAttr).startsWith(normalizedTextContent)) {
titleString = normalizedTextContent + "|" + titleString;
}
}
else if (this.attr("title")) {
// allow @title for backward compatibility
titleString = this.attr("title");
theAttr = "title";
respecEvents.pub("warn", "Using deprecated attribute @title for '" + this.text() + "': see http://w3.org/respec/guide.html#definitions-and-linking");
}
else if (this.contents().length == 1
&& this.children("abbr, acronym").length == 1
&& this.find(":first-child").attr("title")) {
titleString = this.find(":first-child").attr("title");
}
else {
titleString = this.text();
}
// now we have a string of one or more titles
titleString = utils.normalizeString(titleString);
if (args && args.isDefinition === true) {
// if it came from an attribute, replace that with data-lt as per contract with Shepherd
if (theAttr) {
this.attr("data-lt", titleString);
this.removeAttr(theAttr) ;
}
// if there is no pre-defined type, assume it is a 'dfn'
if (!this.attr("dfn-type")) {
this.attr("data-dfn-type", "dfn");
}
else {
this.attr("data-dfn-type", this.attr("dfn-type"));
this.removeAttr("dfn-type");
}
}
titleString.split('|').forEach( function( item ) {
if (item != "") {
titles.push(item);
}
});
return titles;
};
// For any element (usually <a>), returns an array of targets that
// element might refer to, of the form
// {for_: 'interfacename', title: 'membername'}.
//
// For an element like:
// <p link-for="Int1"><a for="Int2">Int3.member</a></p>
// we'll return:
// * {for_: "int2", title: "int3.member"}
// * {for_: "int3", title: "member"}
// * {for_: "", title: "int3.member"}
$.fn.linkTargets = function () {
var elem = this;
var link_for = (elem.attr("for") || elem.closest("[link-for]").attr("link-for") || "").toLowerCase();
var titles = elem.getDfnTitles();
var result = [];
$.each(titles, function() {
result.push({for_: link_for, title: this});
var split = this.split('.');
if (split.length === 2) {
// If there are multiple '.'s, this won't match an
// Interface/member pair anyway.
result.push({for_: split[0], title: split[1]});
}
result.push({for_: "", title: this});
});
return result;
};
// Applied to an element, sets an ID for it (and returns it), using a specific prefix
// if provided, and a specific text if given.
$.fn.makeID = function (pfx, txt, noLC) {
if (this.attr("id")) return this.attr("id");
if (!txt) txt = this.attr("title") ? this.attr("title") : this.text();
txt = txt.replace(/^\s+/, "").replace(/\s+$/, "");
var id = noLC ? txt : txt.toLowerCase();
id = id.split(/[^\-.0-9a-z_]+/i).join("-").replace(/^-+/, "").replace(/-+$/, "");
if (/\.$/.test(id)) id += "x"; // trailing . doesn't play well with jQuery
if (id.length > 0 && /^[^a-z]/i.test(id)) id = "x" + id;
if (id.length === 0) id = "generatedID";
if (pfx) id = pfx + "-" + id;
var inc = 1
, doc = this[0].ownerDocument;
if ($("#" + id, doc).length) {
while ($("#" + id + "-" + inc, doc).length) inc++;
id += "-" + inc;
}
this.attr("id", id);
return id;
};
// Returns all the descendant text nodes of an element. Note that those nodes aren't
// returned as a jQuery array since I'm not sure if that would make too much sense.
$.fn.allTextNodes = function (exclusions) {
var textNodes = [],
excl = {};
for (var i = 0, n = exclusions.length; i < n; i++) excl[exclusions[i]] = true;
function getTextNodes (node) {
if (node.nodeType === 1 && excl[node.localName.toLowerCase()]) return;
if (node.nodeType === 3) textNodes.push(node);
else {
for (var i = 0, len = node.childNodes.length; i < len; ++i) getTextNodes(node.childNodes[i]);
}
}
getTextNodes(this[0]);
return textNodes;
};
var utils = {
// --- SET UP
run: function (conf, doc, cb, msg) {
msg.pub("start", "core/utils");
msg.pub("end", "core/utils");
cb();
}
// --- RESPEC STUFF -------------------------------------------------------------------------------
, removeReSpec: function (doc) {
$(".remove, script[data-requiremodule]", doc).remove();
}
// --- STRING HELPERS -----------------------------------------------------------------------------
// Takes an array and returns a string that separates each of its items with the proper commas and
// "and". The second argument is a mapping function that can convert the items before they are
// joined
, joinAnd: function (arr, mapper) {
if (!arr || !arr.length) return "";
mapper = mapper || function (ret) { return ret; };
var ret = "";
if (arr.length === 1) return mapper(arr[0], 0);
for (var i = 0, n = arr.length; i < n; i++) {
if (i > 0) {
if (n === 2) ret += ' ';
else ret += ', ';
if (i == n - 1) ret += 'and ';
}
ret += mapper(arr[i], i);
}
return ret;
}
, normalizeString: function(str) {
return str.toLowerCase() // mask to lower case
.trim() // trim trailing/leading whitespace
.split(/\s+/) // split on any whitespace
.join(" "); // and replace with a single space
}
// Takes a string, applies some XML escapes, and returns the escaped string.
// Note that overall using either Handlebars' escaped output or jQuery is much
// preferred to operating on strings directly.
, xmlEscape: function (s) {
return s.replace(/&/g, "&")
.replace(/>/g, ">")
.replace(/"/g, """)
.replace(/</g, "<");
}
// Trims string at both ends and replaces all other white space with a single space
, norm: function (str) {
return str.replace(/^\s+/, "").replace(/\s+$/, "").split(/\s+/).join(" ");
}
// --- DATE HELPERS -------------------------------------------------------------------------------
// Takes a Date object and an optional separator and returns the year,month,day representation with
// the custom separator (defaulting to none) and proper 0-padding
, concatDate: function (date, sep) {
if (!sep) sep = "";
return "" + date.getFullYear() + sep + this.lead0(date.getMonth() + 1) + sep + this.lead0(date.getDate());
}
// takes a string, prepends a "0" if it is of length 1, does nothing otherwise
, lead0: function (str) {
str = "" + str;
return (str.length == 1) ? "0" + str : str;
}
// takes a YYYY-MM-DD date and returns a Date object for it
, parseSimpleDate: function (str) {
return new Date(str.substr(0, 4), (str.substr(5, 2) - 1), str.substr(8, 2));
}
// takes what document.lastModified returns and produces a Date object for it
, parseLastModified: function (str) {
if (!str) return new Date();
return new Date(Date.parse(str));
// return new Date(str.substr(6, 4), (str.substr(0, 2) - 1), str.substr(3, 2));
}
// list of human names for months (in English)
, humanMonths: ["January", "February", "March", "April", "May", "June", "July",
"August", "September", "October", "November", "December"]
// given either a Date object or a date in YYYY-MM-DD format, return a human-formatted
// date suitable for use in a W3C specification
, humanDate: function (date) {
if (!(date instanceof Date)) date = this.parseSimpleDate(date);
return this.lead0(date.getDate()) + " " + this.humanMonths[date.getMonth()] + " " + date.getFullYear();
}
// given either a Date object or a date in YYYY-MM-DD format, return an ISO formatted
// date suitable for use in a xsd:datetime item
, isoDate: function (date) {
if (!(date instanceof Date)) date = this.parseSimpleDate(date);
// return "" + date.getUTCFullYear() +'-'+ this.lead0(date.getUTCMonth() + 1)+'-' + this.lead0(date.getUTCDate()) +'T'+this.lead0(date.getUTCHours())+':'+this.lead0(date.getUTCMinutes()) +":"+this.lead0(date.getUTCSeconds())+'+0000';
return date.toISOString() ;
}
// --- STYLE HELPERS ------------------------------------------------------------------------------
// take a document and either a link or an array of links to CSS and appends a <link/> element
// to the head pointing to each
, linkCSS: function (doc, styles) {
if (!$.isArray(styles)) styles = [styles];
$.each(styles, function (i, css) {
$('head', doc).append($("<link/>").attr({ rel: 'stylesheet', href: css }));
});
}
// --- TRANSFORMATIONS ------------------------------------------------------------------------------
// Run list of transforms over content and return result.
// Please note that this is a legacy method that is only kept in order to maintain compatibility
// with RSv1. It is therefore not tested and not actively supported.
, runTransforms: function (content, flist) {
var args = [this, content]
, funcArgs = Array.prototype.slice.call(arguments)
;
funcArgs.shift(); funcArgs.shift();
args = args.concat(funcArgs);
if (flist) {
var methods = flist.split(/\s+/);
for (var j = 0; j < methods.length; j++) {
var meth = methods[j];
if (window[meth]) {
// the initial call passed |this| directly, so we keep it that way
try {
content = window[meth].apply(this, args);
}
catch (e) {
respecEvents.pub("warn", "call to " + meth + "() failed with " + e) ;
}
}
}
}
return content;
}
};
return utils;
}
);