-
Notifications
You must be signed in to change notification settings - Fork 0
/
initial.js
422 lines (349 loc) · 10.7 KB
/
initial.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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
module.exports = initials
// extend public API
initials.addTo = addInitialsTo
initials.parse = parse
initials.find = initials
// defaults
var defaultLength = 2
// there is no support for look-behinds in JS, and the \b selector
// doesn't work with diacritics. So we maintain a blacklist of
// "non letters", that we use later to build our regex.
var nonLetters = ' -\\/:-@\\[-`\\{-\\~'
// regex patterns
var uppercaseLettersOnlyPattern = /^[A-Z]+$/
var initialsInNamePattern = /\(([^)]+)\)/
var nameIsEmailPattern = /^[^\s]+@[^\s]+$/
var findDomainInEmailPattern = /@[^\s]+/
var findEmailPattern = /[\w._-]+@[\w.-]+[\w]/g
// match everything that is a "non letter" (see above)
// followed by all but a "non letter".
// Expl: "Jörg Jäger-Franke" => ["J", " J", "-F"]
var findFirstLettersOfWordsPattern = new RegExp('(^|[' + nonLetters + '])[^' + nonLetters + ']', 'g')
var findAllNonCharactersPattern = new RegExp('[' + nonLetters + ']', 'g')
// PUBLIC API METHODS
//
// initials allows to be used with either a string or an array of strings
//
function initials (nameOrNames, options) {
if (!nameOrNames) return ''
if (typeof nameOrNames === 'string') return initialsForSingleName(nameOrNames, normalize(options))
return initialsForMultipleNames(nameOrNames, normalize(options))
}
//
// finds initials in a name and adds them to the right side
//
function addInitialsTo (nameOrNames, options) {
if (!nameOrNames) return ''
if (typeof nameOrNames === 'string') return addInitialsToSingleName(nameOrNames, normalize(options))
return addInitialsToMultipleNames(nameOrNames, normalize(options))
}
//
// extract name, initials, email
//
function parse (nameOrNames, options) {
if (!nameOrNames) return {}
if (typeof nameOrNames === 'string') return parseSingleName(nameOrNames, normalize(options))
return parseMultipleNames(nameOrNames, normalize(options))
}
// HELPER METHODS
//
// Find initials in a single given name string
//
function initialsForSingleName (name, options) {
var matches
var result
var initials
var length = options.length || 2
initials = findPreferredInitials(name, options)
if (initials) return initials
name = cleanupName(name)
if (!name) return ''
// there is no support for look-behinds in JS, and the \b selector
// doesn't work with diacritics. So we match everything that is a
// "non character" followed by all but a "non character". To fix
// that, we map the results to its last character.
// Expl: "Jörg Jäger" => ["J", " J"] => ["J", "J"]
matches = name.match(findFirstLettersOfWordsPattern).map(function (match) {
return match[match.length - 1]
})
if (matches.length < 2) {
if (name.length > length) {
return name.substr(0, length)
} else {
return name
}
} else {
result = matches.join('')
}
if (result.length >= length) {
return result
}
// This is where it gets complicated.
// Let's say we're in initials('John Doe', 3), so up to here
// we have `result === 'JD'`, but what we want is `result === `JDo`.
// First, we calculate all remaining options that we have
var possibleInitials = getPossibleInitialsForName(name)
var option
// then we return the first option that has the required length
for (var i = 0; i < possibleInitials.length; i++) {
if (possibleInitials[i].length >= length) return possibleInitials[i]
};
// if that didn't work, we return the last possible option
return option
}
//
//
//
function initialsForMultipleNames (names, options) {
var optionsForNames = []
var optionsCountForNames
var map = {}
var duplicatesMap = {}
var initialsForNamesMap = {}
var initials
var possibleInitials
var length = options.length || 2
// get all possible initials for all names for given length
names.forEach(function (name) {
// normalize
if (!name) name = ''
// known name? Gets same initials, stop here
if (initialsForNamesMap[name]) return
// too short to extract initials from? Use name as initials.
if (name.length < length) {
initialsForNamesMap[name] = [name]
return
}
// preferred initials like (JD)? Use these
initials = findPreferredInitials(name, options)
if (initials) {
map[initials] = 1
initialsForNamesMap[name] = [initials]
return
}
// return all possible initials for given length
possibleInitials = getPossibleInitialsForName(name).filter(function (initials) {
if (initials.length !== length) return false
if (map[initials]) duplicatesMap[initials] = 1
map[initials] = 1
return true
})
initialsForNamesMap[name] = possibleInitials
})
// remove duplicates
var keys = []
for (var k in initialsForNamesMap) {
keys.unshift(k)
}
for (var c = keys.length, n = 0; n < c; n++) {
possibleInitials = initialsForNamesMap[keys[n]]
optionsForNames.push(possibleInitials)
for (var i = 0; i < possibleInitials.length; i++) {
if (duplicatesMap[possibleInitials[i]] > 0) {
duplicatesMap[possibleInitials[i]]--
possibleInitials.splice(i, 1)
}
}
}
// make sure we still have options for every name
optionsCountForNames = optionsForNames.map(function (options) { return options.length })
// if names were empty, optionsCountForNames is empty. In that case stop here
if (optionsCountForNames.length === 0) return names
if (Math.min.apply(null, optionsCountForNames) === 0) {
options.length++
return initialsForMultipleNames(names, options)
}
// if we do, return the first option for each
return names.map(function (name) { return initialsForNamesMap[name][0] })
}
//
//
//
function addInitialsToSingleName (name, options) {
var parts = parseSingleName(name, options)
return format(parts)
}
//
//
//
function addInitialsToMultipleNames (names, options) {
return parseMultipleNames(names, options).map(format)
}
//
//
//
function parseSingleName (name, options) {
var initials
var email
var matches
var parts = {}
if (!name) return {}
// are initials part of the name?
initials = findPreferredInitials(name, options)
if (initials) {
// if yes, remove it from name
name = name.replace(uppercaseLettersOnlyPattern, '')
name = name.replace(initialsInNamePattern, '')
}
// use preferred initials if passed
if (options.initials) initials = options.initials
// if no initials found yet, extract initials from name
if (!initials) initials = initialsForSingleName(name, options)
// is there an email in the name?
matches = name.match(findEmailPattern)
if (matches != null) email = matches.pop()
if (email) {
// if yes, remove it from name
name = name.replace(email, '')
// if the email and the name are the same, initials can not be rendered
// the initials method uses email for rendering just when the name is false
// see https://github.com/gr2m/initials/issues/7 for more details
if (name.trim() === '<' + email + '>') {
// set the name to undefined
name = ''
// fire up the initials again with the email
if (!initials) {
initials = initialsForSingleName(email, options)
}
}
}
// clean up the rest
name = name.replace(findAllNonCharactersPattern, ' ').trim()
// do only return what's present
if (name) parts.name = name
if (initials) parts.initials = initials
if (email) parts.email = email
return parts
}
//
//
//
function parseMultipleNames (names, options) {
var initialsArray = initialsForMultipleNames(names, options)
return names.map(function (name, i) {
options.existing[name] = initialsArray[i]
return parseSingleName(name, options)
})
}
//
//
//
function format (parts) {
// neither name nor email: return initials
if (!parts.name && !parts.email) return parts.initials
// no email: return name with initials
if (!parts.email) return parts.name + ' (' + parts.initials + ')'
// no name: return email with initials
if (!parts.name) return parts.email + ' (' + parts.initials + ')'
// return name with initials & name
return parts.name + ' (' + parts.initials + ') <' + parts.email + '>'
}
//
//
//
function cleanupName (name) {
// in case the name is an email address, remove the @xx.yy part
// otherwise remove an eventual email address from name
if (nameIsEmailPattern.test(name)) {
name = name.replace(findDomainInEmailPattern, '')
} else {
name = name.replace(findEmailPattern, '')
}
// replace all non characters with ' ' & trim
name = name.replace(findAllNonCharactersPattern, ' ').trim()
return name
}
//
//
//
function findPreferredInitials (name, options) {
var matches
// if preferred initials passed for current name
if (options.existing[name]) return options.existing[name]
// if the name contains only upcase letters, let's take it as the initials as well
if (uppercaseLettersOnlyPattern.test(name)) {
return name
}
// are the initials part of the given name, e.g. »Eddie Murphie (em)«?
matches = name.match(initialsInNamePattern)
// if yes, return them
if (matches != null) {
return matches.pop()
}
}
//
// e.g. for John Doe:
// - JDo
// - JDoe
// - JoDoe
// - JohDoe
// - JohnDoe
//
var cache = {}
function getPossibleInitialsForName (name) {
var parts
var partsPossibilities
var options = []
name = cleanupName(name)
if (cache[name]) {
return cache[name].slice(0) // return copy
}
// split names into parts
// 'John Doe' => ['Doe', 'John']
parts = name.split(' ')
// map parts to all its possible initials
// 'John' => ['J', 'Jo', 'Joh', 'John']
partsPossibilities = parts.map(getPossibleInitialsForWord)
options = combineAll(partsPossibilities)
// sort options, shortest first
options = options.sort(function (a, b) {
return a.length - b.length || options.indexOf(a) - options.indexOf(b)
})
// cache for future
cache[name] = options
// return options
return options.slice(0)
}
//
//
//
function combineAll (array) {
var current = array.shift()
var temp
var results
if (array.length > 0) {
results = []
temp = combineAll(array)
current.forEach(function (value1) {
temp.forEach(function (value2) {
results.push(value1 + value2)
})
})
return results
} else {
return current
}
}
//
//
//
function getPossibleInitialsForWord (word) {
var options = []
while (word.length) {
options.unshift(word)
word = word.substr(0, word.length - 1)
}
return options
}
//
// make sure that options is always an object, and that
// * options.length is a number and >= defaultLength
// * existing is set and an object
//
function normalize (options) {
if (!options) options = { length: defaultLength }
if (typeof options === 'number') options = { length: options }
options.length = Math.max(options.length || 0, defaultLength)
options.existing = options.existing || {}
return options
}