CocoaPods trunk is moving to be read-only. Read more on the blog, there are 12 months to go.

FuzzySearchi 1.1.0

FuzzySearchi 1.1.0

×

TestsTested ✓
LangLanguage SwiftSwift
License MIT
ReleasedLast Release Dec 2016
SwiftSwift Version 3.0
SPMSupports SPM ✗

Maintained by Viktoras Laukevičius.

FuzzySearchi 1.1.0

  • By
  • Viktoras Laukevičius

FuzzySearch

Lightweight Fuzzy evaluation protocol with CollectionType extension

Requirements

iOS 8.0+ Swift 2.3

Usage

Implementing FuzzySearchable protocol

struct PlayerModel {
  let name: String
  let position: String
  let goals: Int
}

Implementation of FuzzySearchable protocol defines against what search patterns will be evaluated.

extension PlayerModel: FuzzySearchable {
  var fuzzyStringToMatch: String {
    return name
  }
}

Evaluating single FuzzySearchable instance

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 FuzzySearchables

When evaluating collection of FuzzySearchables result is an array of tuples (item: Generator.Element, result: FuzzySearchResult) which is filtered and sorted depending on weight.

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)])
// )
//]

License

FuzzySearch is released under the MIT license.