Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/viktorasl/fuzzysearch
Lightweight Fuzzy evaluation protocol with CollectionType extension
https://github.com/viktorasl/fuzzysearch
filter fuzzy-search search swift
Last synced: 10 days ago
JSON representation
Lightweight Fuzzy evaluation protocol with CollectionType extension
- Host: GitHub
- URL: https://github.com/viktorasl/fuzzysearch
- Owner: viktorasl
- License: mit
- Created: 2016-08-05T13:48:09.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-06-04T16:31:43.000Z (over 7 years ago)
- Last Synced: 2024-10-10T05:35:23.213Z (28 days ago)
- Topics: filter, fuzzy-search, search, swift
- Language: Swift
- Homepage:
- Size: 59.6 KB
- Stars: 4
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FuzzySearch
[](https://travis-ci.org/viktorasl/FuzzySearch)
[](https://github.com/apple/swift-package-manager)
[](https://img.shields.io/cocoapods/v/FuzzySearch.svg)
[](http://cocoadocs.org/docsets/FuzzySearch)
[](https://raw.githubusercontent.com/viktorasl/FuzzySearch/master/LICENSE)
Lightweight Fuzzy evaluation protocol with CollectionType extension
## Requirements
iOS 8.0+
Swift 3.0
## Usage
### Implementing FuzzySearchable protocol
```swift
struct PlayerModel {
let name: String
let position: String
let goals: Int
}
```
Implementation of `FuzzySearchable` protocol defines against what search patterns will be evaluated.
```swift
extension PlayerModel: FuzzySearchable {
var fuzzyStringToMatch: String {
return name
}
}
```
### Evaluating single `FuzzySearchable` instance
```swift
let maradona = PlayerModel(name: "Diego Maradona", position: "F", goals: 16)
maradona.fuzzyMatch("diema") // FuzzySearchResult(weight: 15, parts: [(0,3), (6,2)])
```
#### `FuzzySearchResult`
Result of evaluation carries two properties:
- `weight` - weight of the match
- `parts` - `NSRange`'s of pattern matching against `fuzzyStringToMatch`
### Evaluating collection of `FuzzySearchable`s
When evaluating collection of `FuzzySearchable`s result is an array of tuples `(item: Generator.Element, result: FuzzySearchResult)` which is filtered and sorted depending on `weight`.
```swift
let players = [
PlayerModel(name: "Diego Maradona", position: "CF", goals: 16),
PlayerModel(name: "David Beckham", position: "CAM", goals: 8),
PlayerModel(name: "Lionel Messi", position: "RW", goals: 15)
]
players.fuzzyMatch("di")
//[
// (
// FuzzySearchTests.PlayerModel(name: "Diego Maradona", position: "CF", goals: 16),
// FuzzySearch.FuzzySearchResult(weight: 4, parts: [(0,2)])
// ), (
// FuzzySearchTests.PlayerModel(name: "David Beckham", position: "CAM", goals: 8),
// FuzzySearch.FuzzySearchResult(weight: 2, parts: [(0,1), (3,1)])
// )
//]
```
### `CachedFuzzySearchable`
Wraps over a `FuzzySearchable` instance, caching some underlying metadata generated while fuzzy-matching w/ `FuzzySearchable.fuzzyMatch`.
Use this cached wrapper over `FuzzySearchable` instances that are expected to be fuzzy-matched multiple times without mutation to `fuzzyStringToMatch`:
```swift
let players = [
PlayerModel(name: "Diego Maradona", position: "CF", goals: 16),
PlayerModel(name: "David Beckham", position: "CAM", goals: 8),
PlayerModel(name: "Lionel Messi", position: "RW", goals: 15),
// Many more players ...
]
let fuzzyCachedPlayers =
players.map { player in
CachedFuzzySearchable(wrapping: player)
}
fuzzyCachedPlayers.fuzzyMatch("di")
// Subsequente calls to 'fuzzyMatch' over the array above cause less overhead when re-matching
fuzzyCachedPlayers.fuzzyMatch("di") // Runs in about half time
players.fuzzyMatch("di") // Will fuzzy-match against original, non-cached PlayerModel values.
```
`CachedFuzzySearchable` has storage needs of a little over 2x that of the `fuzzyStringToSearch` property of the wrapped `FuzzySearchable` value. Discarding a `CachedFuzzySearchable` value also discards the extra memory that was allocated.
Returning a different value from the wrapped `FuzzySearchable`'s `fuzzyStringToSearch` property resets the cache automatically during the next `fuzzyMatch` call and the overhead is reset to that of a fresh `CachedFuzzySearchable` instance, so implementers shouldn't worry about mantaining a stable `fuzzyStringToSearch` return.
## License
FuzzySearch is released under the [MIT](LICENSE) license.