Imported "closest match" library matcher from upstream arduino-builder

See arduino/arduino-builder#310

Author: cmaglie

Gopkg.lock

@@ -25,6 +25,7 @@ import (
 	"github.com/arduino/arduino-cli/arduino/libraries"
 	"github.com/arduino/arduino-cli/arduino/libraries/librariesmanager"
 	"github.com/arduino/arduino-cli/arduino/utils"
+	"github.com/schollz/closestmatch"
 	"github.com/sirupsen/logrus"
 )
 
@@ -77,31 +78,46 @@ func (resolver *Cpp) AlternativesFor(header string) libraries.List {
 // header and architecture. If no libraries provides the requested header, nil is returned
 func (resolver *Cpp) ResolveFor(header, architecture string) *libraries.Library {
 	logrus.Infof("Resolving include %s for arch %s", header, architecture)
-	var found *libraries.Library
+	var found libraries.List
 	var foundPriority int
 	for _, lib := range resolver.headers[header] {
 		libPriority := computePriority(lib, header, architecture)
 		msg := "  discarded"
 		if found == nil || foundPriority < libPriority {
-			found = lib
+			found = libraries.List{}
+			found.Add(lib)
 			foundPriority = libPriority
 			msg = "  found better lib"
+		} else if foundPriority == libPriority {
+			found.Add(lib)
+			msg = "  found another lib with same priority"
 		}
 		logrus.
 			WithField("lib", lib.Name).
 			WithField("prio", fmt.Sprintf("%03X", libPriority)).
 			Infof(msg)
 	}
-	return found
+	if found == nil {
+		return nil
+	}
+	if len(found) == 1 {
+		return found[0]
+	}
+
+	// If more than one library qualifies use the "closestmatch" algorithm to
+	// find the best matching one (instead of choosing it randomly)
+	winner := findLibraryWithNameBestDistance(header, found)
+	logrus.WithField("lib", winner.Name).Info("  library with the best mathing name")
+	return winner
 }
 
-func computePriority(lib *libraries.Library, header, arch string) int {
-	simplify := func(name string) string {
-		name = utils.SanitizeName(name)
-		name = strings.ToLower(name)
-		return name
-	}
+func simplify(name string) string {
+	name = utils.SanitizeName(name)
+	name = strings.ToLower(name)
+	return name
+}
 
+func computePriority(lib *libraries.Library, header, arch string) int {
 	header = strings.TrimSuffix(header, filepath.Ext(header))
 	header = simplify(header)
 	name := simplify(lib.Name)
@@ -120,3 +136,25 @@ func computePriority(lib *libraries.Library, header, arch string) int {
 	}
 	return priority
 }
+
+func findLibraryWithNameBestDistance(name string, libs libraries.List) *libraries.Library {
+	// Create closestmatch DB
+	var wordsToTest []string
+	for _, lib := range libs {
+		wordsToTest = append(wordsToTest, simplify(lib.Name))
+	}
+	// Choose a set of bag sizes, more is more accurate but slower
+	bagSizes := []int{2}
+
+	// Create a closestmatch object and find the best matching name
+	cm := closestmatch.New(wordsToTest, bagSizes)
+	closestName := cm.Closest(name)
+
+	// Return the closest-matching lib
+	for _, lib := range libs {
+		if closestName == simplify(lib.Name) {
+			return lib
+		}
+	}
+	return nil
+}

arduino/libraries/librariesresolver/cpp.go

@@ -24,23 +24,45 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-func TestCppHeaderPriority(t *testing.T) {
-	l1 := &libraries.Library{Name: "Calculus Lib", Location: libraries.Sketchbook}
-	l2 := &libraries.Library{Name: "Calculus Lib-master", Location: libraries.Sketchbook}
-	l3 := &libraries.Library{Name: "Calculus Lib Improved", Location: libraries.Sketchbook}
-	l4 := &libraries.Library{Name: "Another Calculus Lib", Location: libraries.Sketchbook}
-	l5 := &libraries.Library{Name: "Yet Another Calculus Lib Improved", Location: libraries.Sketchbook}
-	l6 := &libraries.Library{Name: "AnotherLib", Location: libraries.Sketchbook}
+var l1 = &libraries.Library{Name: "Calculus Lib", Location: libraries.Sketchbook}
+var l2 = &libraries.Library{Name: "Calculus Lib-master", Location: libraries.Sketchbook}
+var l3 = &libraries.Library{Name: "Calculus Lib Improved", Location: libraries.Sketchbook}
+var l4 = &libraries.Library{Name: "Another Calculus Lib", Location: libraries.Sketchbook}
+var l5 = &libraries.Library{Name: "Yet Another Calculus Lib Improved", Location: libraries.Sketchbook}
+var l6 = &libraries.Library{Name: "Calculus Unified Lib", Location: libraries.Sketchbook}
+var l7 = &libraries.Library{Name: "AnotherLib", Location: libraries.Sketchbook}
 
+func TestCppHeaderPriority(t *testing.T) {
 	r1 := computePriority(l1, "calculus_lib.h", "avr")
 	r2 := computePriority(l2, "calculus_lib.h", "avr")
 	r3 := computePriority(l3, "calculus_lib.h", "avr")
 	r4 := computePriority(l4, "calculus_lib.h", "avr")
 	r5 := computePriority(l5, "calculus_lib.h", "avr")
 	r6 := computePriority(l6, "calculus_lib.h", "avr")
+	r7 := computePriority(l7, "calculus_lib.h", "avr")
 	require.True(t, r1 > r2)
 	require.True(t, r2 > r3)
 	require.True(t, r3 > r4)
 	require.True(t, r4 > r5)
 	require.True(t, r5 > r6)
+	require.True(t, r6 == r7)
+}
+
+func TestCppHeaderResolver(t *testing.T) {
+	resolve := func(header string, libs ...*libraries.Library) string {
+		resolver := NewCppResolver()
+		librarylist := libraries.List{}
+		for _, lib := range libs {
+			librarylist.Add(lib)
+		}
+		resolver.headers[header] = librarylist
+		return resolver.ResolveFor(header, "avr").Name
+	}
+	require.Equal(t, "Calculus Lib", resolve("calculus_lib.h", l1, l2, l3, l4, l5, l6, l7))
+	require.Equal(t, "Calculus Lib-master", resolve("calculus_lib.h", l2, l3, l4, l5, l6, l7))
+	require.Equal(t, "Calculus Lib Improved", resolve("calculus_lib.h", l3, l4, l5, l6, l7))
+	require.Equal(t, "Another Calculus Lib", resolve("calculus_lib.h", l4, l5, l6, l7))
+	require.Equal(t, "Yet Another Calculus Lib Improved", resolve("calculus_lib.h", l5, l6, l7))
+	require.Equal(t, "Calculus Unified Lib", resolve("calculus_lib.h", l6, l7))
+	require.Equal(t, "Calculus Unified Lib", resolve("calculus_lib.h", l7, l6))
 }