forked from krisk/Fuse
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathfuse.js
More file actions
800 lines (685 loc) · 23 KB
/
Copy pathfuse.js
File metadata and controls
800 lines (685 loc) · 23 KB
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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
/**
* @license
* Fuse - Lightweight fuzzy-search
*
* Copyright (c) 2012-2016 Kirollos Risk <kirollos@gmail.com>.
* All Rights Reserved. Apache Software License 2.0
*
* Licensed under the Apache License, Version 2.0 (the "License")
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
;(function (global) {
'use strict'
function log () {
console.log.apply(console, arguments)
}
var defaultOptions = {
// The name of the identifier property. If specified, the returned result will be a list
// of the items' dentifiers, otherwise it will be a list of the items.
id: null,
// Indicates whether comparisons should be case sensitive.
caseSensitive: false,
// An array of values that should be included from the searcher's output. When this array
// contains elements, each result in the list will be of the form `{ item: ..., include1: ..., include2: ... }`.
// Values you can include are `score`, `matchedLocations`
include: [],
// Whether to sort the result list, by score
shouldSort: true,
// The search function to use
// Note that the default search function ([[Function]]) must conform to the following API:
//
// @param pattern The pattern string to search
// @param options The search option
// [[Function]].constructor = function(pattern, options)
//
// @param text: the string to search in for the pattern
// @return Object in the form of:
// - isMatch: boolean
// - score: Int
// [[Function]].prototype.search = function(text)
searchFn: BitapSearcher,
// Default sort function
sortFn: function (a, b) {
return a.score - b.score
},
// The get function to use when fetching an object's properties.
// The default will search nested paths *ie foo.bar.baz*
getFn: deepValue,
// List of properties that will be searched. This also supports nested properties.
keys: [],
// Will print to the console. Useful for debugging.
verbose: false,
// When true, the search algorithm will search individual words **and** the full string,
// computing the final score as a function of both. Note that when `tokenize` is `true`,
// the `threshold`, `distance`, and `location` are inconsequential for individual tokens.
tokenize: false,
// When true, the result set will only include records that match all tokens. Will only work
// if `tokenize` is also true.
matchAllTokens: false,
// Regex used to separate words when searching. Only applicable when `tokenize` is `true`.
tokenSeparator: / +/g
}
function Fuse (list, options) {
var i
var len
var key
var keys
this.list = list
this.options = options = options || {}
// Add boolean type options
for (i = 0, keys = ['sort', 'shouldSort', 'verbose', 'tokenize'], len = keys.length; i < len; i++) {
key = keys[i]
this.options[key] = key in options ? options[key] : defaultOptions[key]
}
// Add all other options
for (i = 0, keys = ['searchFn', 'sortFn', 'keys', 'getFn', 'include', 'tokenSeparator'], len = keys.length; i < len; i++) {
key = keys[i]
this.options[key] = options[key] || defaultOptions[key]
}
}
Fuse.VERSION = '2.5.0'
/**
* Sets a new list for Fuse to match against.
* @param {Array} list
* @return {Array} The newly set list
* @public
*/
Fuse.prototype.set = function (list) {
this.list = list
return list
}
Fuse.prototype.search = function (pattern) {
if (this.options.verbose) log('\nSearch term:', pattern, '\n')
this.pattern = pattern
this.results = []
this.resultMap = {}
this._keyMap = null
this._prepareSearchers()
this._startSearch()
this._computeScore()
this._sort()
var output = this._format()
return output
}
Fuse.prototype._prepareSearchers = function () {
var options = this.options
var pattern = this.pattern
var searchFn = options.searchFn
var tokens = pattern.split(options.tokenSeparator)
var i = 0
var len = tokens.length
if (this.options.tokenize) {
this.tokenSearchers = []
for (; i < len; i++) {
this.tokenSearchers.push(new searchFn(tokens[i], options))
}
}
this.fullSeacher = new searchFn(pattern, options)
}
Fuse.prototype._startSearch = function () {
var options = this.options
var getFn = options.getFn
var list = this.list
var listLen = list.length
var keys = this.options.keys
var keysLen = keys.length
var key
var weight
var item = null
var i
var j
// Check the first item in the list, if it's a string, then we assume
// that every item in the list is also a string, and thus it's a flattened array.
if (typeof list[0] === 'string') {
// Iterate over every item
for (i = 0; i < listLen; i++) {
this._analyze('', list[i], i, i)
}
} else {
this._keyMap = {}
// Otherwise, the first item is an Object (hopefully), and thus the searching
// is done on the values of the keys of each item.
// Iterate over every item
for (i = 0; i < listLen; i++) {
item = list[i]
// Iterate over every key
for (j = 0; j < keysLen; j++) {
key = keys[j]
if (typeof key !== 'string') {
weight = (1 - key.weight) || 1
this._keyMap[key.name] = {
weight: weight
}
if (key.weight <= 0 || key.weight > 1) {
throw new Error('Key weight has to be > 0 and <= 1')
}
key = key.name
} else {
this._keyMap[key] = {
weight: 1
}
}
this._analyze(key, getFn(item, key, []), item, i)
}
}
}
}
Fuse.prototype._analyze = function (key, text, entity, index) {
var options = this.options
var words
var scores
var exists = false
var existingResult
var averageScore
var finalScore
var scoresLen
var mainSearchResult
var tokenSearcher
var termScores
var word
var tokenSearchResult
var hasMatchInText
var checkTextMatches
var i
var j
// Check if the text can be searched
if (text === undefined || text === null) {
return
}
scores = []
var numTextMatches = 0
if (typeof text === 'string') {
words = text.split(options.tokenSeparator)
if (options.verbose) log('---------\nKey:', key)
if (this.options.tokenize) {
for (i = 0; i < this.tokenSearchers.length; i++) {
tokenSearcher = this.tokenSearchers[i]
if (options.verbose) log('Pattern:', tokenSearcher.pattern)
termScores = []
hasMatchInText = false
for (j = 0; j < words.length; j++) {
word = words[j]
tokenSearchResult = tokenSearcher.search(word)
var obj = {}
if (tokenSearchResult.isMatch) {
obj[word] = tokenSearchResult.score
exists = true
hasMatchInText = true
scores.push(tokenSearchResult.score)
} else {
obj[word] = 1
if (!this.options.matchAllTokens) {
scores.push(1)
}
}
termScores.push(obj)
}
if (hasMatchInText) {
numTextMatches++
}
if (options.verbose) log('Token scores:', termScores)
}
averageScore = scores[0]
scoresLen = scores.length
for (i = 1; i < scoresLen; i++) {
averageScore += scores[i]
}
averageScore = averageScore / scoresLen
if (options.verbose) log('Token score average:', averageScore)
}
mainSearchResult = this.fullSeacher.search(text)
if (options.verbose) log('Full text score:', mainSearchResult.score)
finalScore = mainSearchResult.score
if (averageScore !== undefined) {
finalScore = (finalScore + averageScore) / 2
}
if (options.verbose) log('Score average:', finalScore)
checkTextMatches = (this.options.tokenize && this.options.matchAllTokens) ? numTextMatches >= this.tokenSearchers.length : true
if (options.verbose) log('Check Matches', checkTextMatches)
// If a match is found, add the item to <rawResults>, including its score
if ((exists || mainSearchResult.isMatch) && checkTextMatches) {
// Check if the item already exists in our results
existingResult = this.resultMap[index]
if (existingResult) {
// Use the lowest score
// existingResult.score, bitapResult.score
existingResult.output.push({
key: key,
score: finalScore,
matchedIndices: mainSearchResult.matchedIndices
})
} else {
// Add it to the raw result list
this.resultMap[index] = {
item: entity,
output: [{
key: key,
score: finalScore,
matchedIndices: mainSearchResult.matchedIndices
}]
}
this.results.push(this.resultMap[index])
}
}
} else if (isArray(text)) {
for (i = 0; i < text.length; i++) {
this._analyze(key, text[i], entity, index)
}
}
}
Fuse.prototype._computeScore = function () {
var i
var j
var keyMap = this._keyMap
var totalScore
var output
var scoreLen
var score
var weight
var results = this.results
var bestScore
var nScore
if (this.options.verbose) log('\n\nComputing score:\n')
for (i = 0; i < results.length; i++) {
totalScore = 0
output = results[i].output
scoreLen = output.length
bestScore = 1
for (j = 0; j < scoreLen; j++) {
score = output[j].score
weight = keyMap ? keyMap[output[j].key].weight : 1
nScore = score * weight
if (weight !== 1) {
bestScore = Math.min(bestScore, nScore)
} else {
totalScore += nScore
output[j].nScore = nScore
}
}
if (bestScore === 1) {
results[i].score = totalScore / scoreLen
} else {
results[i].score = bestScore
}
if (this.options.verbose) log(results[i])
}
}
Fuse.prototype._sort = function () {
var options = this.options
if (options.shouldSort) {
if (options.verbose) log('\n\nSorting....')
this.results.sort(options.sortFn)
}
}
Fuse.prototype._format = function () {
var options = this.options
var getFn = options.getFn
var finalOutput = []
var item
var i
var len
var results = this.results
var replaceValue
var getItemAtIndex
var include = options.include
if (options.verbose) log('\n\nOutput:\n\n', results)
// Helper function, here for speed-up, which replaces the item with its value,
// if the options specifies it,
replaceValue = options.id ? function (index) {
results[index].item = getFn(results[index].item, options.id, [])[0]
} : function () {}
getItemAtIndex = function (index) {
var record = results[index]
var data
var j
var output
var _item
var _result
// If `include` has values, put the item in the result
if (include.length > 0) {
data = {
item: record.item
}
if (include.indexOf('matches') !== -1) {
output = record.output
data.matches = []
for (j = 0; j < output.length; j++) {
_item = output[j]
_result = {
indices: _item.matchedIndices
}
if (_item.key) {
_result.key = _item.key
}
data.matches.push(_result)
}
}
if (include.indexOf('score') !== -1) {
data.score = results[index].score
}
} else {
data = record.item
}
return data
}
// From the results, push into a new array only the item identifier (if specified)
// of the entire item. This is because we don't want to return the <results>,
// since it contains other metadata
for (i = 0, len = results.length; i < len; i++) {
replaceValue(i)
item = getItemAtIndex(i)
finalOutput.push(item)
}
return finalOutput
}
// Helpers
function deepValue (obj, path, list) {
var firstSegment
var remaining
var dotIndex
var value
var i
var len
if (!path) {
// If there's no path left, we've gotten to the object we care about.
list.push(obj)
} else {
dotIndex = path.indexOf('.')
if (dotIndex !== -1) {
firstSegment = path.slice(0, dotIndex)
remaining = path.slice(dotIndex + 1)
} else {
firstSegment = path
}
value = obj[firstSegment]
if (value !== null && value !== undefined) {
if (!remaining && (typeof value === 'string' || typeof value === 'number')) {
list.push(value)
} else if (isArray(value)) {
// Search each item in the array.
for (i = 0, len = value.length; i < len; i++) {
deepValue(value[i], remaining, list)
}
} else if (remaining) {
// An object. Recurse further.
deepValue(value, remaining, list)
}
}
}
return list
}
function isArray (obj) {
return Object.prototype.toString.call(obj) === '[object Array]'
}
/**
* Adapted from "Diff, Match and Patch", by Google
*
* http://code.google.com/p/google-diff-match-patch/
*
* Modified by: Kirollos Risk <kirollos@gmail.com>
* -----------------------------------------------
* Details: the algorithm and structure was modified to allow the creation of
* <Searcher> instances with a <search> method which does the actual
* bitap search. The <pattern> (the string that is searched for) is only defined
* once per instance and thus it eliminates redundant re-creation when searching
* over a list of strings.
*
* Licensed under the Apache License, Version 2.0 (the "License")
* you may not use this file except in compliance with the License.
*/
function BitapSearcher (pattern, options) {
options = options || {}
this.options = options
this.options.location = options.location || BitapSearcher.defaultOptions.location
this.options.distance = 'distance' in options ? options.distance : BitapSearcher.defaultOptions.distance
this.options.threshold = 'threshold' in options ? options.threshold : BitapSearcher.defaultOptions.threshold
this.options.maxPatternLength = options.maxPatternLength || BitapSearcher.defaultOptions.maxPatternLength
this.pattern = options.caseSensitive ? pattern : pattern.toLowerCase()
this.patternLen = pattern.length
if (this.patternLen <= this.options.maxPatternLength) {
this.matchmask = 1 << (this.patternLen - 1)
this.patternAlphabet = this._calculatePatternAlphabet()
}
}
BitapSearcher.defaultOptions = {
// Approximately where in the text is the pattern expected to be found?
location: 0,
// Determines how close the match must be to the fuzzy location (specified above).
// An exact letter match which is 'distance' characters away from the fuzzy location
// would score as a complete mismatch. A distance of '0' requires the match be at
// the exact location specified, a threshold of '1000' would require a perfect match
// to be within 800 characters of the fuzzy location to be found using a 0.8 threshold.
distance: 100,
// At what point does the match algorithm give up. A threshold of '0.0' requires a perfect match
// (of both letters and location), a threshold of '1.0' would match anything.
threshold: 0.6,
// Machine word size
maxPatternLength: 32
}
/**
* Initialize the alphabet for the Bitap algorithm.
* @return {Object} Hash of character locations.
* @private
*/
BitapSearcher.prototype._calculatePatternAlphabet = function () {
var mask = {},
i = 0
for (i = 0; i < this.patternLen; i++) {
mask[this.pattern.charAt(i)] = 0
}
for (i = 0; i < this.patternLen; i++) {
mask[this.pattern.charAt(i)] |= 1 << (this.pattern.length - i - 1)
}
return mask
}
/**
* Compute and return the score for a match with `e` errors and `x` location.
* @param {number} errors Number of errors in match.
* @param {number} location Location of match.
* @return {number} Overall score for match (0.0 = good, 1.0 = bad).
* @private
*/
BitapSearcher.prototype._bitapScore = function (errors, location) {
var accuracy = errors / this.patternLen,
proximity = Math.abs(this.options.location - location)
if (!this.options.distance) {
// Dodge divide by zero error.
return proximity ? 1.0 : accuracy
}
return accuracy + (proximity / this.options.distance)
}
/**
* Compute and return the result of the search
* @param {String} text The text to search in
* @return {Object} Literal containing:
* {Boolean} isMatch Whether the text is a match or not
* {Decimal} score Overall score for the match
* @public
*/
BitapSearcher.prototype.search = function (text) {
var options = this.options
var i
var j
var textLen
var location
var threshold
var bestLoc
var binMin
var binMid
var binMax
var start, finish
var bitArr
var lastBitArr
var charMatch
var score
var locations
var matches
var isMatched
var matchMask
var matchedIndices
var matchesLen
var match
text = options.caseSensitive ? text : text.toLowerCase()
if (this.pattern === text) {
// Exact match
return {
isMatch: true,
score: 0,
matchedIndices: [[0, text.length - 1]]
}
}
// When pattern length is greater than the machine word length, just do a a regex comparison
if (this.patternLen > options.maxPatternLength) {
matches = text.match(new RegExp(this.pattern.replace(options.tokenSeparator, '|')))
isMatched = !!matches
if (isMatched) {
matchedIndices = []
for (i = 0, matchesLen = matches.length; i < matchesLen; i++) {
match = matches[i]
matchedIndices.push([text.indexOf(match), match.length - 1])
}
}
return {
isMatch: isMatched,
// TODO: revisit this score
score: isMatched ? 0.5 : 1,
matchedIndices: matchedIndices
}
}
location = options.location
// Set starting location at beginning text and initialize the alphabet.
textLen = text.length
// Highest score beyond which we give up.
threshold = options.threshold
// Is there a nearby exact match? (speedup)
bestLoc = text.indexOf(this.pattern, location)
// a mask of the matches
matchMask = []
for (i = 0; i < textLen; i++) {
matchMask[i] = 0
}
if (bestLoc != -1) {
threshold = Math.min(this._bitapScore(0, bestLoc), threshold)
// What about in the other direction? (speed up)
bestLoc = text.lastIndexOf(this.pattern, location + this.patternLen)
if (bestLoc != -1) {
threshold = Math.min(this._bitapScore(0, bestLoc), threshold)
}
}
bestLoc = -1
score = 1
locations = []
binMax = this.patternLen + textLen
for (i = 0; i < this.patternLen; i++) {
// Scan for the best match; each iteration allows for one more error.
// Run a binary search to determine how far from the match location we can stray
// at this error level.
binMin = 0
binMid = binMax
while (binMin < binMid) {
if (this._bitapScore(i, location + binMid) <= threshold) {
binMin = binMid
} else {
binMax = binMid
}
binMid = Math.floor((binMax - binMin) / 2 + binMin)
}
// Use the result from this iteration as the maximum for the next.
binMax = binMid
start = Math.max(1, location - binMid + 1)
finish = Math.min(location + binMid, textLen) + this.patternLen
// Initialize the bit array
bitArr = Array(finish + 2)
bitArr[finish + 1] = (1 << i) - 1
for (j = finish; j >= start; j--) {
charMatch = this.patternAlphabet[text.charAt(j - 1)]
if (charMatch) {
matchMask[j - 1] = 1
}
if (i === 0) {
// First pass: exact match.
bitArr[j] = ((bitArr[j + 1] << 1) | 1) & charMatch
} else {
// Subsequent passes: fuzzy match.
bitArr[j] = ((bitArr[j + 1] << 1) | 1) & charMatch | (((lastBitArr[j + 1] | lastBitArr[j]) << 1) | 1) | lastBitArr[j + 1]
}
if (bitArr[j] & this.matchmask) {
score = this._bitapScore(i, j - 1)
// This match will almost certainly be better than any existing match.
// But check anyway.
if (score <= threshold) {
// Indeed it is
threshold = score
bestLoc = j - 1
locations.push(bestLoc)
if (bestLoc > location) {
// When passing loc, don't exceed our current distance from loc.
start = Math.max(1, 2 * location - bestLoc)
} else {
// Already passed loc, downhill from here on in.
break
}
}
}
}
// No hope for a (better) match at greater error levels.
if (this._bitapScore(i + 1, location) > threshold) {
break
}
lastBitArr = bitArr
}
matchedIndices = this._getMatchedIndices(matchMask)
// Count exact matches (those with a score of 0) to be "almost" exact
return {
isMatch: bestLoc >= 0,
score: score === 0 ? 0.001 : score,
matchedIndices: matchedIndices
}
}
BitapSearcher.prototype._getMatchedIndices = function (matchMask) {
var matchedIndices = []
var start = -1
var end = -1
var i = 0
var match
var len = matchMask.length
for (; i < len; i++) {
match = matchMask[i]
if (match && start === -1) {
start = i
} else if (!match && start !== -1) {
end = i - 1
matchedIndices.push([start, end])
start = -1
}
}
if (matchMask[i - 1]) {
matchedIndices.push([start, i - 1])
}
return matchedIndices
}
// Export to Common JS Loader
if (typeof exports === 'object') {
// Node. Does not work with strict CommonJS, but
// only CommonJS-like environments that support module.exports,
// like Node.
module.exports = Fuse
} else if (typeof define === 'function' && define.amd) {
// AMD. Register as an anonymous module.
define(function () {
return Fuse
})
} else {
// Browser globals (root is window)
global.Fuse = Fuse
}
})(this)