Go-fuzzy is a Golang fuzzy search implementation that for given keys returns objects with the closest values to an input.
Inspired by Fuse.
go get github.com/antoan-angelov/go-fuzzy
import "fmt"
import "github.com/antoan-angelov/go-fuzzy"
type Laptop struct {
Manufacturer string
HasFan bool
Processor *CPU
}
type CPU struct {
Manufacturer string
Series string
Cores int
Frequency int
}
func generateLaptops() *[]interface{} {
processor1 := &CPU{Manufacturer: "Intel", Series: "i7", Cores: 4, Frequency: 4}
laptop1 := Laptop{Manufacturer: "Acer", HasFan: true, Processor: processor1}
processor2 := &CPU{Manufacturer: "AMD", Series: "Athlon", Cores: 4, Frequency: 4}
laptop2 := Laptop{Manufacturer: "Lenovo", HasFan: true, Processor: processor2}
return &[]interface{}{laptop1, laptop2}
}
func main() {
laptops := generateLaptops()
fuzzyDemo := fuzzy.NewFuzzy()
fuzzyDemo.Set(laptops)
fuzzyDemo.SetKeys([]string{"Manufacturer", "Processor.Manufacturer"})
results, err := fuzzyDemo.Search("Intle")
if err != nil {
fmt.Println(err)
} else {
fmt.Printf("results = %v\n", results)
// this will print the Acer laptop, because its Processor.Manufacturer field ("Intel") is the closest to the input "Intle"
}
}Search (string) []interface{}
@param {string} pattern The pattern string to fuzzy search on. @return A list of all search matches.
Searches for all the items whose keys (fuzzy) match the pattern.
Set ([]interface{}) []interface{}
@param list @return The newly set list
Sets a new list for GoFuzzy to match against.
SetКeys ([]string, default: nil)
Sets the list of properties to use fuzzy search on. It supports nested properties via dot notation.
SetId (string, default: "")
Name of the identifier property. If set, instead of returning the objects themselves, it will return the specified identifier of the objects.
SetCaseSensitive (bool, default: false)
Whether comparisons should be case sensitive.
SetShouldSort (bool, default: true)
Whether to sort the result list by score.
SearchFn (Searchable, default: defaults.Searcher)
The search function to use. The object must implement Searchable interface:
type Searchable interface {
SetPattern(pattern string, options *fuzzy.Options)
Search(text string) *fuzzy.SearchResult
}GetFn (func(object interface{}, path string) interface{}, default: defaults.DefaultGet)
The method used to access an object's properties. The default implementation handles dot notation nesting (i.e. a.b.c).
SortFn (func(object1 interface{}, object2 interface{}) int, default: defaults.DefaultComparator)
The function that is used for sorting the result list.
SetThreshold (float32, default: 0.6)
At what point the match algorithm gives up. A threshold of 0.0 requires a perfect match (of both letters and location), a threshold of 1.0 would match anything.
The MIT License (MIT)
Copyright (c) 2016 Antoan Angelov
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.