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
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
/* eslint-disable no-shadow */
define([
'jquery',
'underscore',
'mage/utils/objects',
'mage/utils/strings'
], function ($, _, utils, stringUtils) {
'use strict';
var tmplSettings = _.templateSettings,
interpolate = /\$\{([\s\S]+?)\}/g,
opener = '${',
template,
hasStringTmpls;
/**
* Identifies whether ES6 templates are supported.
*/
hasStringTmpls = (function () {
var testString = 'var foo = "bar"; return `${ foo }` === foo';
try {
return Function(testString)();
} catch (e) {
return false;
}
})();
if (hasStringTmpls) {
/*eslint-disable no-unused-vars, no-eval*/
/**
* Evaluates template string using ES6 templates.
*
* @param {String} tmpl - Template string.
* @param {Object} $ - Data object used in a template.
* @returns {String} Compiled template.
*/
template = function (tmpl, $) {
return eval('`' + tmpl + '`');
};
/*eslint-enable no-unused-vars, no-eval*/
} else {
/**
* Fallback function used when ES6 templates are not supported.
* Uses underscore templates renderer.
*
* @param {String} tmpl - Template string.
* @param {Object} data - Data object used in a template.
* @returns {String} Compiled template.
*/
template = function (tmpl, data) {
var cached = tmplSettings.interpolate;
tmplSettings.interpolate = interpolate;
tmpl = _.template(tmpl, {
variable: '$'
})(data);
tmplSettings.interpolate = cached;
return tmpl;
};
}
/**
* Checks if provided value contains template syntax.
*
* @param {*} value - Value to be checked.
* @returns {Boolean}
*/
function isTemplate(value) {
return typeof value === 'string' &&
value.indexOf(opener) !== -1 &&
// the below pattern almost always indicates an accident which should not cause template evaluation
// refuse to evaluate
value.indexOf('${{') === -1;
}
/**
* Iteratively processes provided string
* until no templates syntax will be found.
*
* @param {String} tmpl - Template string.
* @param {Object} data - Data object used in a template.
* @param {Boolean} [castString=false] - Flag that indicates whether template
* should be casted after evaluation to a value of another type or
* that it should be leaved as a string.
* @returns {*} Compiled template.
*/
function render(tmpl, data, castString) {
var last = tmpl;
while (~tmpl.indexOf(opener)) {
tmpl = template(tmpl, data);
if (tmpl === last) {
break;
}
last = tmpl;
}
return castString ?
stringUtils.castString(tmpl) :
tmpl;
}
return {
/**
* Applies provided data to the template.
*
* @param {Object|String} tmpl
* @param {Object} [data] - Data object to match with template.
* @param {Boolean} [castString=false] - Flag that indicates whether template
* should be casted after evaluation to a value of another type or
* that it should be leaved as a string.
* @returns {*}
*
* @example Template defined as a string.
* var source = { foo: 'Random Stuff', bar: 'Some' };
*
* utils.template('${ $.bar } ${ $.foo }', source);
* => 'Some Random Stuff';
*
* @example Template defined as an object.
* var tmpl = {
* key: {'${ $.$data.bar }': '${ $.$data.foo }'},
* foo: 'bar',
* x1: 2, x2: 5,
* delta: '${ $.x2 - $.x1 }',
* baz: 'Upper ${ $.foo.toUpperCase() }'
* };
*
* utils.template(tmpl, source);
* => {
* key: {'Some': 'Random Stuff'},
* foo: 'bar',
* x1: 2, x2: 5,
* delta: 3,
* baz: 'Upper BAR'
* };
*/
template: function (tmpl, data, castString, dontClone) {
if (typeof tmpl === 'string') {
return render(tmpl, data, castString);
}
if (!dontClone) {
tmpl = utils.copy(tmpl);
}
tmpl.$data = data || {};
/**
* Template iterator function.
*/
_.each(tmpl, function iterate(value, key, list) {
if (key === '$data') {
return;
}
if (isTemplate(key)) {
delete list[key];
key = render(key, tmpl);
list[key] = value;
}
if (isTemplate(value)) {
list[key] = render(value, tmpl, castString);
} else if ($.isPlainObject(value) || Array.isArray(value)) {
_.each(value, iterate);
}
});
delete tmpl.$data;
return tmpl;
}
};
});